Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleList of Doctypes for Software Development

The following doctypes help to document your software projects.

Section


Column


Info Box

This list can be overwhelming, but using the templates is usually quite straight forward. To get a quick overview we suggest to open the Prezi presentation (the one we mentioned on the top of the page) which groups the logically closely related document types.

Mind some basics given in How to document a Software Development Project?

For an introduction to using projectdoc doctypes and macros from the author's point of view, have a look at the following documents:

Tour
render-as-definition-listtrue






Column


Tip Box

To organize your information about your software or system, you should have a look at the projectdoc Add-on for arc42. The arc42 Template provides a standard layout of chapters.

On the arc42 Template you can find a lot of useful tips on documenting architectures.




Display Table
doctypedoctype
selectName, Short Description, Set, Documentation Type, Categories
sort-bySort Key, Name
where$<Suite>=[Software Development]
render-counter-columntrue

...