All Documentation Should Be Dated
Published 📅: ....
Last modified 📝: ....
Location 📍: Boston, MA
Share this status update on BlueskySee discussion on Bluesky
The title basically says it all - if you manage docs (specifically a documentation website), your docs should show the date and time of when the docs were created and last updated.
I'm sure most of us have been looking at some docs for a library or feature and then find out later through experimentation or when talking with coworkers that those docs are at least 6+ months out of date.
Add a quick timestamp at the top of the page showing when the docs were created (and also add one for when the docs were last updated)!
Tags:
Bluesky Post and Comments:
Loading comments...
Related Posts
micropost
Published: ....
Published: ....
Published: ....
Leveraging service monitors properly to improve service observability.
Published: ....
It's fine for a library to express some opinions about how it should be adopted and how the overall workflow/application in which it is adopted should function. However, it's false advertising to say that it is unopinionated.
Published: ....
No I don't mean those Milano cookies you keep taking from the office snack wall either (although you should probably stop snacking on those as often as well).
Published: ....
Low/no process workflow wasn't actually no process, it was only an "invisible" process. An implicit contract with everyone on the team to do that async workflow on their own time.