Do you clearly show who last edited a rule or document?


Have you ever read a document and wondered if it was still relevent - or who last touched it?

Nothing undermines confidence faster than uncertainty about a document's freshness or ownership. When readers can't tell who last updated a rule or when it was last changed, they're left guessing whether to trust or ignore it.

Clear authorship and update information turn that uncertainty into accountability.

The Checklist to Better Document Ownership

  • Add a visible "Last Updated by [Name]" to every rule or document (Tip: Even better, link this to the updated Git commit)
  • Include clearly the date when the document was last updated (Tip: Include a time-zone for less chance of confusion)
  • For open-source documentation, add a link allowing to the source of the document, so that users can easily make edits
  • Provide a link to the full change history, showing all commits to the source file (e.g. "See History on GitHub")

bad example no ownership
Figure: Bad example ([GitHub Documentation](https://docs.github.com/en/github-cli/github-cli/about-github-cli)) - Is this Documentation Still Valid?

ok example
Figure: Ok example ([MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators)) - Last Modified Information at the Bottom of the Page

good example tina
Figure: ⭐ Good Example ([Tina.io Documentation](https://tina.io/docs)) - Ownership and Last Modified Information Clear at Top of Document


Josh Berman
We open source.Loving SSW Rules? Star us on GitHub. Star
Stand by... we're migrating this site to TinaCMS