# Writing Documentation

> Writing and editing documents and Markdown files.

- Skill: `muhammedalkhudiry/writing-documentation` (Agent Skill)
- Install (CLI): `npx skillmds@latest add muhammedalkhudiry/writing-documentation`
- Raw SKILL.md: https://api.skillmd.com/api/skills/muhammedalkhudiry/writing-documentation/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: MuhammedAlkhudiry (https://skillmd.com/u/muhammedalkhudiry)
- Updated: 2026-09-10
- Page: https://skillmd.com/skills/muhammedalkhudiry/writing-documentation

---


Follow $how-to-respond.

- Keep documentation minimal by default. Include only what readers need to understand the subject or act correctly.
- Check facts before editing. Give each fact or instruction one authoritative source. Link to that source elsewhere, and mark claims you cannot verify
  as unresolved.
- Link to the source instead of copying details that may change. For example, link to `--help` for command options, a schema for field names, or code
  for current behavior.
- Look for outdated or repeated documentation while you work. Fix any you find immediately.
- Read the finished document and inspect the diff. Check for lost or invented meaning. Run any available Markdown and link checks. Report major
  structural changes, factual corrections, and unresolved gaps.
- Keep only durable decisions, boundaries, non-obvious guidance, and completion contracts. Do not restate discoverable inventories, syntax, options,
  behavior, or implementation.