Words To Avoid in Educational Writing | CSS-Tricks
I'm no English major, but as a writer and consumer of loads of educational (mostly tech) writing, I've come to notice a number of words and phrases that come
Documentation
Let's stop saying 'It's Simple!' in technical documents
Technical writing and editing services
Docs for Developers
Learn to integrate the craft of writing with the craft of programming. This book teaches you how to create documentation for each step in...
The Product is Docs
This book provides a broad perspective about the essential aspects of creating technical documentation in today's product development wor...
What a deploy bot taught Glossier’s engineering team about documentation – Increment: Documentation
How Glossier used a reader-centric approach to simplify their development team’s code deployment process and improve velocity.
Asana
A beginner’s guide to writing documentation — Write the Docs
Writing for Developers
Written communication tips for effective software developers
Writing for Developers - Zapier Visual Identity
Zapier Visual Identity
A primer on documentation content strategy – Increment: Documentation
Tips to help engineering teams produce high-quality documentation—with or without the support of designated technical writers.
Writing Documentation When You Aren't A Technical Writer - Part Two
Avoiding oversimplification, writing good error messages, and having better word choice
Writing Documentation When You Aren't A Technical Writer - Part One
How do people actually read documentation and how to write documentation and code samples to maximize developer success
What nobody tells you about documentation
However hard you work on documentation, it won't work for your software - unless you do it the right way.
Ten Extras for Great API Documentation
Take your API documentation to the next level with these expert tips from Diana Lakatos.
The problem with Frequently Asked Questions (FAQs) in documentation
Many tech writers have a heavy disdain for Frequently Asked Questions (FAQs) in documentation. At first this disdain seemed a bit unfounded and elitist to me, but now, after a recent project, I'm starting to understand the reasons for the disdain. All too often the FAQ format is abused by non-writers who want an easy way to write. The list of random questions grows with each incoming question until it's a ridiculous hodgepodge of information thrown together, with no larger story or narrative.