This paragraph is the assembly introduction. It explains what the user will accomplish by working through the modules in the assembly and sets the context for the user story the assembly is based on. Can include more than one paragraph. Consider using the information from the user story.

Prerequisites

  • A bulleted list of conditions that must be satisfied before the user starts following this assembly.

  • You can also link to other modules or assemblies the user must follow before starting this assembly.

  • Delete the section title and bullets if the assembly has no prerequisites.

Target platforms

This paragraph is the concept module introduction and is only optional. Include it to provide a short overview of the module.

The contents of a concept module give the user descriptions and explanations needed to understand and use a product.

  • Look at nouns and noun phrases in related procedure modules and assemblies to find the concepts to explain to users.

  • Explain only things that are visible to users. Even if a concept is interesting, it probably does not require explanation if it is not visible to users.

  • Do not include any instructions to perform an action, such as executing a command. Action items belong in procedure modules.

Additional resources

Deployment architecture diagram

This paragraph is the concept module introduction and is only optional. Include it to provide a short overview of the module.

The contents of a concept module give the user descriptions and explanations needed to understand and use a product.

  • Look at nouns and noun phrases in related procedure modules and assemblies to find the concepts to explain to users.

  • Explain only things that are visible to users. Even if a concept is interesting, it probably does not require explanation if it is not visible to users.

  • Do not include any instructions to perform an action, such as executing a command. Action items belong in procedure modules.

Additional resources

Tags: