Generate API documentation, READMEs, and step-by-step guides.
npx skills add https://github.com/bdbch/ai-dotfiles --skill technical-writing-bdbch
Please help me install this Agent Skill. Skill: technical-writing Source: https://github.com/bdbch/ai-dotfiles/tree/main/skills/technical-writing Command: npx skills add https://github.com/bdbch/ai-dotfiles --skill technical-writing-bdbch
This Skill streamlines the creation of technical documentation, saving time and ensuring clarity in API docs, READMEs, and other technical writing tasks.
Run the technical-writing skill to create a new guide for your project, specifying the audience and key sections you want to include.
High-intent search queries and answers about installing and using this skill.
To generate API documentation, this skill automates the creation of detailed references including parameters, return values, and examples for developers. It produces comprehensive API guides that streamline software documentation tasks.
Improving a README involves enhancing existing content with clear setup instructions, API references, and contribution guidelines. This skill automates README improvement to ensure clarity and comprehensive technical writing for your project.
Creating step-by-step technical guides is done by producing walkthroughs of realistic scenarios for end users. This skill automates guides creation to help internal and external users understand software systems and APIs.
Yes, you can use this skill for both internal and external software documentation. It generates comprehensive technical writing, including API documentation and guides, to assist all users in understanding your software systems.
Yes, you need to specify the audience and key sections you want to include when generating technical writing. Specifying the audience ensures the automated documentation and guides are tailored to the appropriate reader level.
tc9011Generate Diátaxis-framework technical documentation in Markdown.
JongsixGenerate technical documentation from source code and API definitions.
nesihaver-ILUpdate README, API, architecture docs, and changelogs after code changes.
wlfmnstrEvaluate static site generator frameworks for GitHub Pages deployment.
