# Write Clear Technical Documentation

Technical teams lose time when docs mix assumptions, unclear scope, and hard-to-scan instructions. This skill helps Claude, Codex, and Claude Code produce structured, cited, and maintainable technical documents.

## Install

```bash
npx skillstore add dcjanus/tech-doc
```

## Metadata

- Status: approved
- Slug: dcjanus-tech-doc
- Skillstore revision: r1
- Version status: missing
- Tree hash: 367880aa3b17a519fa74cfebcabd2ab97bbc6ecdaa48dafb823d8f318adeadb6
- Author: DCjanus
- GitHub username: DCjanus
- License: MIT
- Repository: https://github.com/DCjanus/prompts/tree/master/skills/tech-doc
- Ref: 72d5025b022c77f7a51bdf5c1637c689c80e89d1
- 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: external\_commands
- Quality score: 78
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/dcjanus-tech-doc
- Manifest: https://skillstore.pages.dev/api/skills/dcjanus-tech-doc/manifest

## Capabilities

- Structures explanation documents around what, why, outcome, context, and reader needs.
- Guides SOP and quick reference pages with scope, prerequisites, examples, and common errors.
- Requires source boundaries, citations, versions, and access dates for key references.
- Improves Markdown hierarchy, lists, code blocks, links, and image accessibility text.
- Prompts collaboration when context is missing, assumptions are unclear, or risks need review.

## Use Cases

- Create Feature Documentation: Turn implementation notes into a scoped explanation with reader assumptions, outcomes, boundaries, and supporting evidence.
- Write Operational SOPs: Build a concise procedure with prerequisites, risk notes, copyable examples, common errors, and related references.
- Standardize Team Docs: Define shared rules for Markdown structure, citations, terminology, command examples, and review handoffs.

## Prompt Templates

### Draft a Basic Doc

```
Use the tech-doc skill to draft a short explanation document from these notes. State the goal, reader, scope, and outcome first.
```

### Rewrite for Clarity

```
Use the tech-doc skill to rewrite this document. Keep facts unchanged, reduce assumptions, tighten headings, and mark any missing information.
```

### Build an SOP

```
Use the tech-doc skill to create an SOP. Include scope, prerequisites, risk notes, shortest safe example, common errors, and references.
```

### Audit Documentation Quality

```
Use the tech-doc skill to review this technical document. Identify unsupported claims, unclear terms, missing citations, risky examples, and maintenance gaps.
```

## Limitations

- Does not gather missing source material or verify facts without provided references.
- Does not execute commands; it only guides how command examples should be written.
- Does not replace expert review for regulated, safety-critical, or production change documents.
- The source instructions are primarily Chinese, so localization preferences may need clarification.

## Best Practices

- Provide source notes, target reader, scope, and required terminology before asking for a draft.
- Ask the assistant to mark uncertain facts instead of filling gaps from assumption.
- Review command examples, permissions, and references before publishing operational documents.

## Anti Patterns

- Do not ask the skill to invent missing facts, metrics, or unsupported conclusions.
- Do not publish command examples without reviewing permissions, placeholders, and dry-run options.
- Do not mix tutorials, references, and SOPs without a clear reader goal.

## Security Audit

- Audited at: 2026-07-06T11:14:11.337\+00:00
- Summary: The static command finding is a false positive because SKILL.md line 23 describes how to format shell examples in documentation. The entropy alert is also a false positive; the file is coherent Markdown text with Chinese content, not obfuscated or encrypted data. No prompt injection or malicious semantic intent was found.

## Stats

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