Articles
Development - Internal Technical Documentation Template (Draft)
Overview
Technical documentation created by development is intended to provide knowledge transfer from our department out to the rest of the organization. It can be used as the source for user guides as well as the source of truth on how featur...
Example Doc with data (based on template)
Menu path
Setup > Company > User Manager
Overview
This screen lists existing users in a grid. You can complete these actions:
Add users to the system.
Can filter by active or inactive users. Can filter by internal users o...
Template for development documentation (new product)
Menu Path
Where to find the feature/screen in the software
Overview
Brief description of the screen/feature. What does it do? Why would someone use it?
Prerequisites/Dependencies
What needs to be done before using this scree...
Template for [Bold Group Product] with 3rd Party Software Integration
Part 1: Overview
What is this document about?
What does the integration do? (What is its business purpose?)
What can’t it do?
Part 2: Requirements
[Bold Group Product] and Version
[3rd Party Product] and Version
An...