IntroductionLast updated: 16/01/2023
Introduction documents are used to provide additional documentation, know how, guidelines and examples to understand the background of a specific topic
1.1 Introduction
Provide a brief introduction describing the scope and purpose of the documentation. Where applicable we include the following sections.
Overview and background
if there is an historical context to the purpose of the documentation please include here for reference.
Related information
if there are additional resources or concepts that need to be understood that relevant to the documentation include a reference here.
Examples
Where the documentation relates to particular use case provide an example together with optional references for further reading for the user. For example if you are writing software documentation that required server side rendering you may wish to include a reference on the link to related documentation on the node.js website.
Further reading
Additional guides, explanation documents and resources (internal / external)
1.2 Release Notes
Include the product name and official release version (optional release & build number), and/or the release date.
New and updated features list
List of new features with links to feature in the documentation.
Fixed bugs list
List of bugs and ticket id / case number / forum post with links to feature in the documentation.
Known issues list
List of outstanding issues reported and not fixed. Link to ticket id / case number / forum post that describes the problem and a potential workaround.
Download link
Links to the specific software downloads for each module + platform
Supported platforms and environments
Links (in this manual) to product install requirements, prerequisites , system, hardware.
Removed features
List of any features have been removed or replaced.
Installation & upgrade instructions
Link (in this manual) to 2.1 Installation section