How should we document best practices with the tools we are using?

[rudimusmaximus]

objective / purpose
How to document best practices with the tools we are using. For example, git hooks or commit templates in GitKraken, packages and themes in atom, etc.

completion checklist

• [ ] Discovered in: whichx.y.z or n/a
• [ ] Resolved/introduced in: whichx.y.z
• [ ] Design Ready - labels, estimates
• [ ] Development Ready - design and change list created, updated complexity label and estimates
• [ ] Changes Listed (mark each member as completed update as needed)
  • [ ] one
  • [ ] two
  • [ ] three
  • [ ] four
  • [ ] five
• [ ] Developer Tested - Test Copies (Disposable Alpha "DA!s" and Release Candidate)

POST LIVE:

• [ ] Beta Tested - Live to controlled audience  
• [ ] Customer Experience - Live analytics reveal working for customers  

full pipeline documentation

---

Overview - describe with history and related items

Solution Design

working list

• repo wiki
• as issues with md docs inside repo
• other

What's New Entry

Solution Implementation Notes

Developer Testing- Disposable Alpha and Release Candidate

Live Testing - Beta live to controlled audience

Customer Experience - Re-open and append if issues for customers

[rudimusmaximus]

Examples of practices to document:

• GitKraken v3.5 Release - Commit Templates
• pre-commit git hooks
• spell checking linter
• clipboard managers
• using crouton