Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionThe product and the documentation of the product should be in different release cycles. 
Doctypepatternhide
NameSeparate Release Cycles 
Short Name 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
propertyAudience
 
Subject
Name List
doctypesubject
propertySubject
 
Categories
Name List
doctypecategory
propertyCategories
 
Tags
Tag List
propertyTags
 
Domain

Name List
doctypepattern-domain
namesDocumentation
propertyDomain

 
Type

Name List
doctypepattern-type
namesKnowledge Organization
propertyType

 
PrinciplesSeparation of Concerns, Principle of Iteration 
Iteration

Iteration
valuefacadefinished

hide
Sort Keyhide
Section
titleDescription

 

Section
titleExample

Section
show-titlefalse
titleContext

A product has many components to be delivered to the customer. The documentation is one of these components. Although the documentation is often developed with the product features, it is also often difficult to get both right at the same time. How can we handle required updates to the documentation if there are no required changes to the product?

Section
show-titlefalse
titleProblem
Panel
How should we deliver the product and its documentation to the customer?
Section
titleStructure

The product and the documentation of the product should be in different release cycles.

The reason for this separation is that the documentation responds to different forces than the product. While it is true that a new feature probably needs also to be documented in the user guide, bug fixes do not necessarily do. Feedback from users may demand that the user guide needs to be updated to make the information easier to understand. Maybe there is an error in the documentation that is not related to the product. Therefore there are situations where the product needs to be released, but not the documentation. And on the other side, the documentation needs to be released, but not the product.

So it is beneficial to have the two release cycles separated.

Section
titleExample
Section
titleContext
Advantages
  • Independent release cycles support teams to push only updated and relevant information to the users.
Section
titleProblemDisadvantages
  • There need still be some planing to sync the documentation release with the product release. A user has no benefit from a documentation that is not in-sync with the product.
Section
titleStructure
Section
titleAdvantages
Section
titleDisadvantages
Section
titleVariants

Section
titleSubordinate Patterns
Display Table
doctypepattern
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name
Section
titleRelated Practices
intro-textThe following practices are related to this practice.
Tour
replace-title-with-nametrue
Section
required-permissionswrite-access
titleNotes

Section
titleReferences

Section
titleResources