Versions Compared

Key

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

...

Document Properties Marker
hidetrue
extract-short-desctrue


 
Short DescriptionProvides 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. 
Doctypetopichide
NameDoctypes for Software Developmenthide
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
 
Expected Duration
Categories
Name List
doctypecategory
names/ projectdoc / Doctype Add-on
propertyCategories
 

Tags
Tag List
namesDoctype Add-on
propertyTags
 
Iteration
Iteration
valuefinished
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesDoctype Set
propertyType
hide
Project Logo

hide
SetSoftware Developmenthide
Blueprint Key Prefixde.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-swdev:projectdoc-swdev-blueprint-doctype-hide
Status

Status
colourGreen
titleavailable

hide
Marketplacehttps://marketplace.atlassian.com/plugins/de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-swdevhide
Source Repositoryhttps://bitbucket.org/smartics/smartics-doctype-model-swdevhide
Sort Key000100hide



Section


Column

  

Panel
borderColorlightgrey

Take an alternative introduction to the Doctypes for Software Development


Transclusion
documentDoctypes
idslocalization



Column


Panel
titleColorwhite
titleBGColororange
titleInstall Doctypes for Software Development!

Install the doctypes add-on for software development now and for free via

Atlassian MarketplaceImage Modified


Transclusion
documentDoctype Add-on Sources
idsSoftware Development



...

Section
idDescription
titleOverview


Section


Column
width65%

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.


Column
width35%


Panel
borderColordarkgrey
titleBGColoryellow
titleAuthor's Dashboard vs. Landing Page

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.

 

 





Section


Column

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.


Column
width30%


Panel
titleColorwhite
titleBGColororange
titleInstall additional Doctypes!

Install additional Doctype Add-ons now and for free via

Atlassian Marketplace




...

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

...