Skip to content

Instantly share code, notes, and snippets.

@igor822

igor822/documentation.md

Created April 22, 2018 16:36
Show Gist options
  • Save igor822/2fded88a11d165e9cf168be4fa4beb50 to your computer and use it in GitHub Desktop.
Save igor822/2fded88a11d165e9cf168be4fa4beb50 to your computer and use it in GitHub Desktop.
Download ZIP
Simple documentation template
Raw
documentation.md

Project / Module Name

What (vision or end result)

Eg.: This system will....

Why (motivation or logic)

// Why the system is used for

Who (accountable positions)

// Who will use it

When (timing and length)

// When the feature is used and the expected result

Hou much (measuring standards)

// What is the cost of it

With what (required resources)

// Which resources will be used, being input or batch resources

How (system steps)

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