Provides doctypes to create documentation in software development projects. The focus is on documenting the architecture of the product, but it includes templates for other software development documentation requirements as well.
Take an alternative introduction to the Doctypes for Software Development
Overview
The Doctypes for Software Development help agile teams to document their software architecture.
Create a space and you have a basic structure, a repository, to add the relevant information for your stakeholders.
The screenshot on the left shows the author's view. It contains links to documentation modules and types, tags, categories you usually want to see as an author, but not as a reader. See it as the authors' working dashboard. The space homepage contains the links that are relevant for readers. It is the landing page of the space.
This is the landing page provided by the The Software Development Add-on:
It leaves more space to add information most relevant to the readers of this space.
After you have created your space use the page blueprints to create documents for project constraints, requirements, views, architecture aspects (aka concepts) and many more.
The different topics are part of a document that comprise usually one wiki page. Since these pages are loosely coupled, they can be combined for different audience groups (e.g. using Tours or Volumes) easily. This makes it natural to run single source documentation principles and employ advanced features like transclusions or automatic lists. If the concepts you want to discuss are complex, you are not limited to a single page. Use the Section or other doctypes to create pages for modular content.
Due to home and index pages it is easier for authors to store new documents.
List of Doctypes for Software Development
The following doctypes help to document your software projects.
The query matched no documents.
Resources
- Doctypes - more doctypes for projectdoc.
- Macros - macros to be used in your doctype templates.