Addressing critical needs driven by the dynamic world of #techDocs, Manny Silva has created Docs as Tests, a system that integrates well-developed #techComms practices and a collection of engineering tooling to help #technicalWriters streamline and constantly improve their software #documentation and #QA work.
This was a fun chat with a deeply experienced Silicon Valley #content veteran. I hope you enjoy the conversation as much as I did.
Min.js Style Compression of Tech Docs for LLM Context
https://github.com/marv1nnnnn/llm-min.txt
#HackerNews #MinJS #Compression #TechDocs #LLM #Context #GitHub
The good news - software engineers know how to do these things, or can find help along the way!
My thoughts in detail here: https://adambkaplan.com/post/2025-03-15-docs-software-problem/
#documentation #opensource #writing #blog #techdocs
/end
To get our docs quality to match our code quality, we need to treat our documentation as a software design problem. Just like our code, we need to write documentation with clear goals of what problems we are trying to solve (and for whom!), a vision for our ideal end state, an understanding of the tools at our disposal, and a plan to organize our ideas.
#documentation #opensource #techdocs
/3
It is not surprising that most of the "bad docs" are maintained by software engineers, and unfortunately we do not apply the same rigor to our documentation as we do to our code.
#documentation #opensource #techdocs
/2
Lately I have been involved with open source projects that struggle with their documentation. It's easy to identify bad documentation out in the wild - many of us have an intuitive sense when a project's docs are hard to understand.
#documentation #opensource #writing #techdocs
/1
I wrote a guide to migrating VuePress sites to VitePress
🚀 Struggling with fragmented API documentation across multiple products?
Want to improve your developer experience and reduce support requests?
Check the presentation below where I unveil a strategic approach to unify and enhance API documentation tailored for large organizations facing scattered API docs and inconsistent standards across products. 📚
In this presentation, I cover:
✅ Auditing existing documentation for consistency.
✅ Creating a unified style guide and using automated tools.
✅ Building a centralized documentation portal.
✅ Collaborating with diverse stakeholders for a cohesive strategy.
If you're a documentation manager, a product manager, or a technical writer looking to streamline your API docs and empower internal teams and external developers, this is for you!
If you have any questions, doubts, suggestions, or feedback, feel free to leave a comment.
#APIDocumentation #DeveloperExperience #TechnicalWriting #ProductManagement #APIs #DX #DeveloperExperience #TechDocs #SoftwareDocumentation
https://drive.google.com/file/d/1CyPzuUrz5S8uEIkj2YfXMts_41kQBOHM/view?usp=drive_link
Larry Swanson
N-gated Hacker News
Hacker News
Adam Kaplan 🚌🚊🚢
Henry Bley-Vroman
Miguel Afonso Caetano
Yetkin Degirmenci 🍫