Skip to content

Instantly share code, notes, and snippets.

@pthieu

pthieu/project-documentation-template.md

Last active November 8, 2018 17:38
Show Gist options
  • Save pthieu/c6263ba3d5dccc7baa51ff97f33fae69 to your computer and use it in GitHub Desktop.
Save pthieu/c6263ba3d5dccc7baa51ff97f33fae69 to your computer and use it in GitHub Desktop.
Download ZIP
Project Documentation Template
Raw
project-documentation-template.md

Project Documentation Template

Overview

  • Problem/Motivation
  • Solution
  • Execution Plan

Architecture

  • Critical Path/Flow
  • Swimlane diagram (flow and critical path)
  • Components overview
  • Full components diagram

Requirements/Scope

API

  • Routes
  • Request/response examples

Test Strategy

  • Manual test suite/coverage
  • Manual QA script/instructions
  • Automated unit tests
  • Automated integration tests

Dependencies

  • External
  • Internal

Deployment

  • How to deploy local machine
  • How to configure: .env, cloud info, routing, dns, ingress, egress
  • How to deploy stage/production
  • How to test
  • How to update
  • Backup/Restore

Debug

  • Debug script/instructions
  • Common problems and solutions
  • Critical points of failure
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment