based-africa

Great documentation is not just about what you say but how you say it and how efficiently you help your users accomplish their goals.

Just as we test and validate our code to make sure it works, so does editing our documentation requires validation, testing, and review to ensure it meets the user's needs.

Editing requires the skills of a detective, an architect, and a craftsperson. It is a collaborative process that involves testing assumptions and gathering feedback. 

Read my latest article review extracted from the book docs for developers. Ensure to drop your feedback in the comment section if you find it helpful.

Great documentation is not just about what you say but how you say it and how efficiently you help your users accomplish their goals.

Just as we test and validate our code to make sure it works, so does editing our documentation requires validation, testing, and review to ensure it meets the user's needs.

Editing requires the skills of a detective, an architect, and a craftsperson. It is a collaborative process that involves testing assumptions and gathering feedback. 

Read my latest article review extracted from the book docs for developers. Ensure to drop your feedback in the comment section if you find it helpful.


https://www.linkedin.com/pulse/chapter-4-editing-documentation-beyond-spellcheck-etugbo-judith-ebewf