Writing good documentation is assisted by writing good code in the first place. The better the code, the less work it should take to document it. User martianE points out the different role ...

Community driven content discussing all aspects of software development from DevOps to design patterns. Implicit in the relationship between a writer and a reader is the request for attention. Through ...

Technical documentation refers to the written materials that provide information about the technical aspects of a product, process, or system. In the context of information technology (IT), technical ...

Community driven content discussing all aspects of software development from DevOps to design patterns. In Ye Olden Days, I was a COBOL programmer, working on a Unisys E1100 system with a CODASYL ...

Generative AI tools are putting a new spin on the age-old chore of writing and consuming technical documentation. The key is knowing your audience, your purpose, and which tools to use for the job.

Technical writing is often thought of as a way to communicate complex information in a simple, easy-to-understand, no-frills manner. This does not have to be just for scientific journals; technical ...

Great API documentation is essential to a good developer experience. But your documentation should be great for non-developers too. When software moved online, so did the documentation. Today, hosted ...

Checking up occasionally on your writing skills is a good idea. Why? Much of our communication today consists of emails and texts. I don’t know anyone who would say communication isn’t important. If ...

Technical writing is more demanding than that of your everyday content writing because it has a clear purpose – to present a tech product in simple language as to be understood by ordinary people. So ...