Helping other engineers improve their soft skills: technical documentation, communication, and more. Join my mailing list here: https://erikjmelone.com/newsletter
Two very good points - you’re right in that a Wiki could auto generate the scope/table of contents, I just prefer to write it out myself ahead of time to give myself an idea on what I’ll be writing.
The takeaway idea is great! I’ve never thought of adding that to technical documentation - will have to experiment with that a bit more.
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
Really like the Baseline idea, which could also answer the question "Who is this document for?"
The "Scope" looks like a Table of Contents, which a Wiki could autogenerate.
I would add that a "Takeaway"/TLDR section at the end of any document (what you did here!) is really beneficial.
Two very good points - you’re right in that a Wiki could auto generate the scope/table of contents, I just prefer to write it out myself ahead of time to give myself an idea on what I’ll be writing.
The takeaway idea is great! I’ve never thought of adding that to technical documentation - will have to experiment with that a bit more.