Hi everyone,
In Logos, we’re starting a long-term project to improve our technical documentation. Many of us have felt the same issues: hard-to-maintain docs, unclear contributor onboarding, fragmented toolchains, and repeated support questions.
To address these, Chen (Discord: chen06324) and I (campo4171) are introducing a design-first workflow for technical documentation. This will:
- Provide LLM-friendly templates, guides, and checklists so writing and updating docs become predictable.
- Focus on information design first, reducing ambiguity and making docs easier to write and maintain.
- Begin with a pilot phase before a wider rollout.
The goal: contribute to Logos’ sustainability by making contributions easier and more consistent across our projects.
I’ve written a detailed post outlining this project foundation; you can read more here if you’re interested: A documentation playbook for open source projects.
We’ll share updates as the pilot progresses. In the meantime, your feedback and questions are welcome.
Thank you.