Blog

  • 2024
  • 2023
  • 2022
  • 2021
  • 2020
  • 2019
  • 2018
  • 2017
  • 2016
  • 2015
  • 2014
  • 2013
  • 2012




We are happy to announce our new space on agile documentation!

Within this space we provided information about values of good documentation. We list principles that support theses values and practices that make those principles actionable. The practices are shown in pattern form and therefore include both, advantages and disadvantages that come with the application of the practice.

The values for readers are described in the book Developing Quality Technical Information by Gretchen Hargis, Michelle Carey, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, and Elizabeth Wilde.

Most of the principles we list are well known by software developers and people with an agile mindset. Some principles are used by technical writers.

We also link to tools, especially macros and doctypes (aka blueprints), from our projectdoc Toolbox for Confluence that support a given practice. This may give users of this add-on an alternative approach to learn how to use these tools.. But the information on values and principles, and most patterns is not tool-specific and therefore may be used with any tools.

If you have comments or suggestions, please let us know!



Link

Link

Posts