Generate API references, ADRs, and READMEs in markdown.
npx skills add https://github.com/0xRayAI/xray --skill tech-writer-0xrayai
Please help me install this Agent Skill. Skill: tech-writer Source: https://github.com/0xRayAI/xray/tree/main/src/skills/tech-writer Command: npx skills add https://github.com/0xRayAI/xray --skill tech-writer-0xrayai
This Skill eliminates the friction of maintaining high-quality technical documentation by providing a structured framework for writing API docs, ADRs, and READMEs that stay in sync with your codebase.
Use the tech-writer skill to generate a standard README file for the current project directory including a quick start section and installation instructions.
High-intent search queries and answers about installing and using this skill.
To generate a project README, this Skill produces a standard markdown file including a quick start section and installation instructions tailored for developers. It structures your repository context into a developer-friendly format.
An architecture decision record (ADR) captures the context, options, and rationale behind an architectural change. You need an ADR when introducing structural changes to ensure your team remains aligned on the decision-making process.
You can write API references that stay in sync by applying documentation-as-code principles, maintaining markdown files alongside source code to ensure version alignment and facilitate peer review via pull requests.
Yes, this documentation approach requires adherence to markdown-based documentation-as-code principles for seamless integration into repository workflows. It enforces consistent terminology, active voice, and code-centric formatting.
The best way to maintain consistent terminology is to use a structured framework that enforces active voice and code-centric formatting across API docs, ADRs, and READMEs. This eliminates friction and standardizes all technical references.
You should not use documentation-as-code if your project requires non-markdown formats or operates outside standard repository workflows. This Skill specifically enforces markdown-based formatting and version alignment via pull requests.
ToowireddAnalyze repository structure, languages, frameworks, and technical debt into Markdown documentation.
georgekhananaevEnforce consistent Markdown syntax across documentation and README files.
d0d012Generate and update Markdown documentation for APIs, READMEs, ADRs, and code comments.
oborchersDesign API documentation and developer experience strategies with implementation guidance.
