Get Started


Product Documentation

When building a product and developing features we ensure that the product has complete documentation by following iterative documentation practices.

The product documentation is completed iteratively as we work on each major feature, contributing to the complete documentation repository of the product. By creating product documentation iteratively we ensure that we keep track of the product as we build and include all necessary information.

Documenting Practices

When creating documentation, we ensure that it is:

  1. Concise and Clear

    We ensure that our documentation is written in a way that can be understood by any reader, is clearly formatted, and focuses on specific points.

  2. Accurate and Comprehensive

    We ensure that all features of the product and the factors that went into building the product are all accurately documented.

  3. Structure and Searchable

    We ensure that our documentation is laid-out with usability in mind, ensuring that all documents are organized into clear categories and easily searchable to find specific content.

Document Types

Each product is set up with a central document repository to store all content related to the project, including:

  1. Product Overview
  2. Architecture Design Documentation
  3. Technical Documentation
  4. Release Documentation
  5. Requirements & Feature Documentation
  6. System Administrator Documentation
  7. End-User Documentation

1. Product Overview Document

The product overview document acts as the main reference point for the project and houses all documents and links related to the project. The central product overview document contains all major documents with a link to each document and any links to external resources.

The overview document lists:

  1. An overview of the project
  2. Links to all major document types
  3. Links to all document templates
  4. External links related to the project:
    • Design files
    • Environments
    • Google Play / Apple Store links
    • Project management tools
    • etc.

2. Architecture Design Documentation

When we begin to work on each new major feature or plan out new major iterations of the product we first draw up and plan all of the system architecture using diagrams to detail out the architecture and implementation.

Once system architecture is approved it is added to the documentation repository to keep a record of all architecture decisions.

3. Technical Documentation

As we iterate on the product and make new technical decisions we ensure that these are all stored and documented. The technical documentation can include the following:

  1. Code Frameworks & Standards Documentation

    An outline of the frameworks, coding principles, and standards followed when implementing the product, including but not limited to;

    • Frameworks
    • Design patterns
    • Security measures
    • Principles
  2. API Documentation

    A list of all APIs used, the purpose of each API, and how to connect to the APIs.

  3. Libraries & Licenses

    A list of all libraries and licenses used with version numbers listed.

4. Release Documentation

For each product release, we set up a new release document. The release document will list:

  1. Release Objective
    • Target for release
    • Release dates
    • Release impact
  2. Features included in the release
  3. Any links that relate to the release
  4. Members included in the release
  5. Release plan
    • Timeline
    • Environments

5. Requirements & Feature Documentation

As each new feature enters planning a new document is set up to manage the feature. The feature document gives an outline of the full feature and lists out all epics and user stories required to achieve the required functionality. The features document lists:

  1. Feature Objective

  2. Main intentions of the feature

  3. Criteria of acceptance

  4. Image / video content

    • Explanations of feature usage
    • Visual references for feature states
  5. Design and user interaction

    • Links to any related UX files:
      • User personas
      • User scenarios
      • Scenario maps
      • User story maps
      • UX style guides
      • Prototypes
    • Links to any final UI design files
  6. Requirements for functionality

    • Key requirements in the feature
    • Breakdown of each requirement
    • Links to the epics related to each requirement
      • Epic summary
      • The main goal of the epic
      • Links to all related user stories
  7. Code references

    Code snippets with markup, libraries, API endpoints, parameters, coding conventions, and additional references to explain the functionality.

6. System Administrator Documentation

The system administrator documentation lists out any content required for admin users to manage the product, helping ensure product continuity and ease in maintenance. Including:

  1. Description of main product functions
  2. Guide to system administration
  3. Environment management

7. End-User Documentation

The end-user documentation ensures that the main instructions for end-users are listed, including:

  1. Standard usage guidelines
  2. User FAQs

Our Playbook

View all playbook

Ready to start building?

Let's begin
Subscribe to our Newsletter

Receive the latest news on technology and product development from CodeLink.



(+84) 28 39333143

[email protected]