When writers collaborate with engineers from the start, documentation becomes a core part of the product. They stay in sync with code and actually solve user problems.
Many developers say “no docs is better than bad or outdated docs”
Bad docs usually come from broken processes, not bad writers
When docs are an afterthought, writers reverse-engineer decisions they weren't part of. They document what got built, not why it was built that way
🧵
You know REST APIs, but what about the ones already built into your browser?
They’re known as Web APIs or Browser APIs that make your apps more interactive with features like speech, offline mode, translation, and real-time chat.
Read more 👇
https://t.co/9lYgjIAGOy
Looking for technical writing resources? We’ve got you!
Came across this great collection by @damiezekiel_. It covers guides, communities, and tools for technical writers.
Don’t forget to ⭐️ the repo if you find it useful.
https://t.co/FXcpZMeEEY
Many of us have been avoiding em dashes due to "ChatGPT-generated" allegations. The real issue isn't using em dashes, it's misusing them like ChatGPT does.
Here's a guide on em dashes and other punctuation you might be using incorrectly.
Read more 👇
https://t.co/QS9UzlSTNh
📝 Want to write better docs?
Start by reading more docs.
Good ones. Bad ones. Confusing ones.
You'll learn what works and what to avoid.
#technicalwriting#writethedocs#readthedocs
Did you know technical writing skills appear in job descriptions under different titles and not just "Technical Writer"?
Expand your job search with these alternative titles!
[Thread]👇
Why does “WARNING!!!” feel like it’s shouting?
Why "userName" in JavaScript but “user_name" in Python?
Letter casing influences how we read, feel, and respond to content. It shapes and affects user experience.
Read more 👇
https://t.co/uYybSlb6FU
Writing isn’t one-size-fits-all, but good writing follows certain principles and standards.
Here are some common technical writing mistakes and how to avoid them 👇
https://t.co/2pTLpOUgQJ
Writing isn’t one-size-fits-all, but good writing follows certain principles and standards.
Here are some common technical writing mistakes and how to avoid them 👇
https://t.co/2pTLpOUgQJ
Your Markdown docs look clean, but are they?
Broken links, messy headings, and inconsistent formatting can ruin the user experience.
Here’s how to automate quality checks with Markdownlint + Husky + Lint-staged.
#devtools#documentation
https://t.co/TTT6014pMi
🚀 Docsify Documentation Template
Want to set up structured documentation without complex build steps? Here's a Docsify template to help you get started.
✅ Pre-configured sidebar, navbar, and cover page
✅ Plugins for search, code copy, and pagination
https://t.co/laYubQ2O4Y
New Post Alert 🚨
While some documentation tools can be overly technical to customize or use, Docsify lets you create clean, structured docs with just Markdown.
This guide walks you through setup and customization.
https://t.co/a5jAOk7T7L