skills.rest
shinnytech
shinnytechOFFICIAL
Explore all skills by this author →
WebsiteGitHub

documentation-writing

Write software documentation following the Eight Rules and Diataxis framework.

Updated Jan 13, 2026
Search Tags:#documentation#writing#readme#tutorial#diataxis#developer guides
One-click install
npx skills add https://github.com/shinnytech/caiwenqiang-member-rank --skill documentation-writing-shinnytech
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-writing
Source: https://github.com/shinnytech/caiwenqiang-member-rank/tree/main/.cursor/skills/documentation-writing
Command: npx skills add https://github.com/shinnytech/caiwenqiang-member-rank --skill documentation-writing-shinnytech

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

This Skill solves the problem of creating high-quality, maintainable, and discoverable documentation that adheres to established best practices and frameworks like Diataxis.

Core Features & Use Cases

  • Enforces Documentation Standards: Automatically ensures documentation follows the "Eight Rules" and Diataxis framework.
  • Structured Document Creation: Provides templates and guidance for Tutorials, How-Tos, References, and Explanations.
  • Use Case: When developing a new feature, use this Skill to generate a comprehensive README file, a tutorial for new users, and API reference documentation, all adhering to project standards.

Quick Start

Use the documentation writing skill to create a new tutorial document.

Frequently Asked Questions about documentation-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write clear and discoverable software documentation?▼

Structure software documentation using the Diataxis framework, which divides content into tutorials, how-to guides, technical references, and explanations to ensure clarity and discoverability for different user needs.

What is the best way to generate a README file that follows documentation standards?▼

Generate a README file by applying the Eight Rules and Diataxis framework, automatically enforcing the docs/ location, linking requirements, and runnable examples to maintain high project standards.

How do I create developer guides and tutorials that separate learning from reference?▼

Create developer tutorials and how-to guides using the Diataxis framework, which separates learning-oriented content from action-oriented guides and information-oriented references for better discoverability.

Does this documentation writing approach work for API docs and runnable examples?▼

Yes, this documentation writing approach works for API docs and automatically enforces runnable examples, linking requirements, and structured references to ensure code documentation remains accurate and maintainable.

When do I need to use the Diataxis framework for project documentation?▼

Use the Diataxis framework for project documentation when you need to create structured README files, API references, or tutorials that enforce consistent standards, linking requirements, and runnable examples.

Related Skills

Explore More Content & Communication Skills→
coakenfoldcoakenfold

technical-writer

Generate Markdown documentation from source code and API references.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
georgekhananaevgeorgekhananaev
27

md

Enforce consistent Markdown syntax across documentation and README files.

Community
Basic
FaysilAlshareefFaysilAlshareef
4

api-docs

Enrich OpenAPI specifications with summaries, descriptions, and examples.

Community
Intermediate