documentation-writer

Generate Diátaxis-aligned documentation across tutorials, how-tos, references, and explanations.

1|Updated Apr 7, 2026
One-click install
npx skills add https://github.com/han-so1omon/ikam --skill documentation-writer-han-so1omon
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/han-so1omon/ikam/tree/main/skills/documentation-writer
Command: npx skills add https://github.com/han-so1omon/ikam --skill documentation-writer-han-so1omon

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Technical writers often struggle to maintain consistency and depth across four documentation quadrants for complex software projects.

Core Features & Use Cases

  • Diátaxis-guided content generation that produces four-quadrant documentation sets.
  • Consistent tone, terminology, and structure across tutorials, how-tos, references, and explanations.
  • Use case: Onboarding new developers with API usage guides plus conceptual explanations.

Quick Start

Generate a complete four-quadrant documentation draft for a new software feature using the Diátaxis framework.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
What is Diátaxis framework documentation and when do I need it for software projects?

Diátaxis framework documentation splits software content into tutorials, how-tos, references, and explanations to ensure consistent depth across engineering, product, and content teams. You need it when onboarding new developers or building end-to-end API guides requires structured content separation.

How do I write technical documentation that covers tutorials, how-tos, and references consistently?

To write technical documentation consistently, generate a four-quadrant documentation set aligned with the Diátaxis framework, applying structured frontmatter, clear sectioning, and actionable Quick Start prompts to maintain uniform tone and terminology across tutorials, how-tos, references, and explanations.

Can I use this approach to generate API usage guides and developer onboarding materials together?

Yes, you can generate API usage guides and developer onboarding materials together by applying the Diátaxis framework to produce a complete four-quadrant documentation draft that integrates actionable Quick Start prompts with conceptual explanations for new software features.

What's the best way to structure a complete four-quadrant documentation draft for a new software feature?

The best way to structure four-quadrant documentation is using the Diátaxis framework, which provides structured frontmatter and clear sectioning to separate tutorials, how-tos, references, and explanations, ensuring consistent terminology and actionable Quick Start prompts across the entire draft.

Does this documentation generation method work for engineering, product, and content teams needing end-to-end guides?

Yes, this documentation generation method works for engineering, product, and content teams by applying Diátaxis-guided content generation to produce consistent, end-to-end documentation sets that maintain uniform tone and terminology across tutorials, how-tos, references, and explanations for complex software projects.