Skip to content

Instantly share code, notes, and snippets.

@philipz

philipz/nodes.md

Created August 9, 2021 14:37
Show Gist options
  • Save philipz/e75ace87a2536f5fcb7174d78698dc1a to your computer and use it in GitHub Desktop.
Save philipz/e75ace87a2536f5fcb7174d78698dc1a to your computer and use it in GitHub Desktop.
Download ZIP
Documenting Software Architectures Views and Beyond
Raw
nodes.md

Seven Rules for Sound Documentation

  1. Write Documentation from the Reader’s Point of View
  2. Avoid Unnecessary Repetition
  3. Avoid Ambiguity 3.a Explain Your Notation
  4. Use a Standard Organization
  5. Record Rationale
  6. Keep Documentation Current but Not Too Current
  7. Review Documentation for Fitness of Purpose
@philipz
Copy link
Author

philipz commented Aug 9, 2021

template

@philipz
Copy link
Author

philipz commented Aug 9, 2021

template1

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