documentation-writer
The documentation-writer skill generates technical documentation following the Diátaxis framework. It guides users through a structured process of clarification, outline proposal, and content generation.
Is documentation-writer safe to install?
Safe to install: our audit of documentation-writer's source files found 0 shell commands, 0 external URLs, file reads and writes (low risk). Every command and URL listed appears verbatim in the skill's source. The skill reads local markdown files to maintain tone and terminology consistency but does not execute shell commands or perform network requests.
How we audit skills: our security review methodology.
Who is this skill for?
Technical writers and developers who need to produce structured software documentation.
What can you do with it?
- Creating tutorials for new users
- Writing how-to guides for specific technical tasks
- Drafting reference material for software components
- Developing explanatory content for complex topics
How good is this skill?
Quality score: 9/10. The skill provides a clear, structured workflow and adheres to a specific documentation framework. It lacks automated tool execution, which limits its utility for automated CI/CD pipelines but increases security.
What does the skill file contain?
# Diátaxis Documentation Expert You are an expert technical writer specializing in creating high-quality software documentation. Your work is strictly guided by the principles and structure of the Diátaxis Framework (https://diataxis.fr/). ## GUIDING PRINCIPLES 1. **Clarity:** Write in simple, clear, and unambiguous language. 2. **Accuracy:** Ensure all information, especially code snippets and technical details, is correct and up-to-date. 3. **User-Centricity:** Always prioritize the user's goal. Every document must help a specific user achieve a specific task. 4. **Consistency:** Maintain...
Frequently asked questions
Does the skill automatically write documentation without approval?
No. The skill requires the user to approve a proposed outline before it generates the full content.
Can the skill access external documentation websites?
No. The skill only consults external sources if the user provides a link and explicit instructions.
How does the skill maintain project consistency?
The skill reads provided markdown files to identify the existing tone, style, and terminology of the project.
Related skills
caveman
308.9KUsers seeking to reduce token consumption during AI interactions without sacrificing technical precision
A communication style skill that reduces token usage by approximately 75% by removing filler, articles, and pleasantries while maintaining technical accuracy. It supports multiple intensity levels including lite, full, ultra, and classical Chinese variants.
github-actions-docs
264.6KDevelopers and DevOps engineers working with GitHub Actions workflows
The github-actions-docs skill provides grounded answers to GitHub Actions queries by retrieving information from official GitHub documentation. It assists with workflow syntax, security, migration, and runner configuration.
brainstorming
256.4KDevelopers and project managers who need to define requirements, architecture, and design for software projects before writing code
A structured brainstorming framework that guides users through project exploration, design proposal, and specification before implementation. It enforces a strict design-first workflow, requiring user approval for designs and documentation before transitioning to the writing-plans skill.
writing-plans
174.7KSoftware engineers and AI agents tasked with implementing complex features from specifications
The writing-plans skill generates structured, task-based implementation plans for software development projects. It enforces a specific markdown format that includes architecture, tech stack, global constraints, and granular, test-driven development steps for each task.