Skip to content

Instantly share code, notes, and snippets.

@anushshukla

anushshukla/technical-documentation-template.md

Last active September 26, 2023 13:59
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save anushshukla/0df127d227586a02bb4f348d4afc8fd5 to your computer and use it in GitHub Desktop.
Save anushshukla/0df127d227586a02bb4f348d4afc8fd5 to your computer and use it in GitHub Desktop.
Download ZIP
Technical documentation template
Raw
technical-documentation-template.md

Problem statement

business required for the product feature

Solution

overview of the engineering solution

System design

Ex: add HLD images with description

Detailed designs

Ex: add LLD details

Database design

API contract

Interfaces

Function signatures

Algoright pseudo

Milestones

Ex: trunk based deployments and production deliverables

Effort estimation

Ex: effort estimation

Timeline

Ex: considering leaves, holidays, resources bandwidth, etc.

Testing

Scope

Impact area

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment