✍️Critical Writing Rules for Developers
Writing for devs just got a lot harder
TL;DR
New guidelines for tech writing enforce strict rules, including bans on personal names and direct quotes. Developers must now carefully adhere to these rules to avoid making content unusable.
New guidelines for tech writing have been established, enforcing strict rules that developers must follow to ensure content remains usable. These rules include an absolute ban on using personal names and direct quotes, requiring writers to paraphrase instead. The guidelines aim to maintain clarity and professionalism in technical communication, but they also introduce significant constraints for writers. Developers must now be meticulous in their adherence to these rules, as any violation can render their work unusable. The guidelines also emphasize the importance of avoiding generic phrasing and focusing on specific tools, workflows, and decisions.
Key Points
New guidelines for tech writing enforce strict rules, including bans on personal names and direct quotes.
Writers must now paraphrase instead of using direct quotes to maintain clarity and professionalism.
The guidelines aim to ensure that content remains usable and avoids generic phrasing.
Developers must be meticulous in their adherence to these rules to avoid making their work unusable.
The guidelines emphasize the importance of focusing on specific tools, workflows, and decisions.
Why It Matters
If you're writing technical documentation or blog posts, these new rules will impact your workflow. The ban on personal names and direct quotes means you'll need to be more careful with attribution and paraphrasing. This is especially important for maintaining clarity and professionalism in technical communication, but it also introduces significant constraints for writers. Anyone creating content for developers must now adhere to these rules to ensure their work remains usable and relevant.
Comments
Be the first to comment
Enjoyed this article?
Get it daily. 7am. Free. Reads in 5 minutes.
Join 3,555 builders reading daily.