doc-writing

Structure technical documentation into Diátaxis content quadrants.

12|3|Updated Jan 11, 2026
One-click install
npx skills add https://github.com/VidyFoo/antigravity-skill-engine --skill doc-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-writing
Source: https://github.com/VidyFoo/antigravity-skill-engine/tree/main/.agent/skills/4-tools/doc-writing
Command: npx skills add https://github.com/VidyFoo/antigravity-skill-engine --skill doc-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is often scattered, inconsistent, and hard to maintain; this skill provides a structured approach to create, organize, and maintain high-quality technical documentation using the Diátaxis framework.

Core Features & Use Cases

  • Framework-guided documentation: Classify content into Tutorials, How-to Guides, Reference, and Explanation.
  • Template and style guidance: Leverages the included style-guide, diataxis, and readme templates to standardize outputs.
  • Versatile document generation: Produce API docs, user guides, knowledge bases, and internal documentation efficiently.

Quick Start

Outline your documentation project using the four Diátaxis quadrants and apply the included templates to generate a consistent documentation package.

Frequently Asked Questions about doc-writing

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

FAQPage Schema
How do I structure technical documentation using the Diátaxis framework?

Structure technical documentation using the Diátaxis framework by classifying content into four distinct quadrants: Tutorials, How-to Guides, Reference, and Explanation. This approach organizes scattered information into a clear, maintainable knowledge base.

What is the best way to standardize API docs and user guides?

Standardize API docs and user guides by applying a frontmatter-driven structure alongside included style-guide and resource templates. This enforces consistent formatting across all enterprise documentation workflows and knowledge bases.

Can I generate a markdown knowledge base with predefined templates?

Generate a markdown knowledge base using predefined Diátaxis and readme templates. The framework-guided approach standardizes outputs, ensuring your technical writing aligns with established style guidelines across all documentation projects.

When should I separate tutorials from how-to guides in a knowledge base?

Separate tutorials from how-to guides in a knowledge base when following the Diátaxis framework, which distinguishes learning-oriented tutorials from task-oriented how-to guides to improve clarity and maintainability of technical documentation.

Does this approach work for enterprise documentation workflows?

Yes, this approach supports enterprise documentation workflows by enforcing a structured frontmatter-driven process. It classifies API docs, user guides, and internal documentation into the four Diátaxis content quadrants for consistent maintenance.