My Book - Working For Real: My Book - Working For Realhttps://beta.jimiwikman.se/management/my-book-working-for-real/the-tools/confluence/?d=21My Book - Working For Real: My Book - Working For RealenA basic structure in Confluence for System Documentationhttps://beta.jimiwikman.se/management/my-book-working-for-real/the-tools/confluence/a-basic-structure-in-confluence-for-system-documentation-r33/ When it comes to Confluence the most important thing to keep in mind is how to structure information. Confluence as a tool has endless of possibilities, which is both its strength and its weakness. You can easily build monsters if you do not have a documentation strategy. One of the areas I have found that it is pretty easy to define a structure is for system documentation, so we will start with that here.

One key aspect of good documentation is to limit the number of entry points in our documentation tree. I like to use the 7+1 design for system documentation. That is because it is easy to remember, and it is for the most part a logical division of the documentation for a system. We then try to maintain the number of categories under each node as well to avoid the categorization to be too broad.

The Node sections we want for system documentation are:

  1. Architecture
  2. Document
  3. Instruction
  4. Quality
  5. Requirements
  6. Technical Solutions
  7. Initiative
  8. Visual Design

The plus one in this list is the Visual Design part since not all systems have a graphical interface.

 

]]>33Sun, 13 Dec 2020 15:34:40 +0000