# Create Clear Diátaxis Documentation

Software documentation often mixes learning, task, reference, and conceptual content. This skill separates those needs and produces focused Markdown for a defined audience.

## Install

```bash
npx skillstore add github/documentation-writer
```

## Metadata

- Status: approved
- Slug: github-documentation-writer
- Skillstore revision: r2
- Version status: missing
- Tree hash: eddb2d651c521b482050912b70de8ae768b3474baee1330c696343fce4a42daa
- Author: github
- GitHub username: github
- License: MIT
- Repository: https://github.com/github/awesome-copilot/tree/main/skills/documentation-writer/
- Ref: c43861a65bb95efcae259cd161c9d6f4dc7eec6f
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: network
- Quality score: 77
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/github-documentation-writer
- Manifest: https://skillstore.pages.dev/api/skills/github-documentation-writer/manifest

## Capabilities

- Creates tutorials, how-to guides, reference material, and explanations.
- Clarifies the document type, audience, user goal, and scope before drafting.
- Proposes a detailed outline and waits for approval before writing full content.
- Writes clear, consistent software documentation in Markdown.
- Uses provided Markdown files to match project tone, style, and terminology.

## Use Cases

- Onboard New Developers: Create a structured tutorial that leads new team members from setup to a successful first result.
- Document Support Procedures: Turn a recurring operational task into a focused how-to guide with clear scope and ordered steps.
- Organize Product Knowledge: Separate mixed source material into reference and explanation documents for easier maintenance and discovery.

## Prompt Templates

### Create a Beginner Tutorial

```
Create a tutorial that teaches [audience] to achieve [goal]. Include [topics] and exclude [topics]. Ask necessary questions before proposing the outline.
```

### Plan a How-To Guide

```
Plan a how-to guide for [task] using these project details: [context]. Propose an outline and wait for approval before drafting.
```

### Build Technical Reference

```
Create reference documentation for [component]. Cover [interfaces, parameters, behaviors, and errors] for [audience], using [provided files] as style context.
```

### Design a Documentation Set

```
Design a Diátaxis documentation set for [product]. Map [source material] into four document types, identify gaps, and propose linked outlines before drafting.
```

## Limitations

- Requires user approval of the proposed outline before producing the full document.
- Does not consult external sources unless the user provides a link and requests research.
- Cannot independently verify that technical details are current or operationally correct.
- Does not copy from provided Markdown files unless the user explicitly requests copying.

## Best Practices

- State the audience, reader goal, document type, and scope in the initial request.
- Provide current technical facts and existing Markdown when terminology or style must match a project.
- Review the proposed outline carefully before approving the full draft.

## Anti Patterns

- Do not combine tutorial, how-to, reference, and explanation goals in one document.
- Do not request accurate commands or interfaces without supplying verified technical details.
- Do not skip audience and scope decisions when the document serves a specific workflow.

## Security Audit

- Audited at: 2026-07-23T17:53:11.145\+00:00
- Summary: The skill contains prompt guidance for technical writing and no executable network operation. The Diátaxis website URL is a framework citation, not a request target or data transfer mechanism.

## Stats

- Views: 124
- Downloads: 24
- Favorites: 1
- Popularity score: 0