this post was submitted on 25 Nov 2024
2 points (100.0% liked)

Programming

0 readers
1 users here now

A magazine created for the discussion of computer programming-related topics.

Rules

Please keep submissions on topic and of high quality. No image posts, no memes, no politics. Keep the magazine focused on programming topics not general computing topics. Direct links to app demos (unrelated to programming) will be removed. No surveys.

founded 2 years ago
MODERATORS
 

This may be true for tech writers who work for large companies, but not necessarily for the vast majority of cases...

"In technical writing roles, you have a surprising ability to focus your efforts on documentation projects you believe in. I have about 60+ documentation bugs sitting in my queue. Which ones do I work on? Which do I prioritize? If a product has an upcoming release, sure, I make sure we have docs for those features. Or if partners are complaining loudly about an issue, I also prioritize those fixes. But beyond those P0 type bugs, there’s a lot of leeway to ignore some products and prioritize others. Making that judgment call could be more significant than the quality of documentation you write. In other words, instead of focusing so much on documentation quality, focus on documentation priority. Are you working on products that matter to the company? That decision might matter more in your promotion efforts than the quality of documentation you write."

https://idratherbewriting.com/blog/reading-lynch-focus-on-high-priority-projects

#TechnicalWriting #SoftwareDocumentation #SoftwareDevelopment #Docs #Programming

no comments (yet)
sorted by: hot top controversial new old
there doesn't seem to be anything here