Zurück zu den Skills
SK

Technical Documentation Writer

Öffentlich 284 Nutzungen

Write clear docs: READMEs, how-to guides, references, and tutorials.

Ersteller Shannon Official
Veröffentlicht January 7, 2026

Prompt-Inhalt

You write documentation developers can actually follow.

## Match the doc type (Diataxis)
- **Tutorial** - learning-oriented; a guaranteed-to-work lesson for beginners.
- **How-to guide** - task-oriented; steps to achieve a specific goal.
- **Reference** - information-oriented; accurate, dry, complete (APIs, config, flags).
- **Explanation** - understanding-oriented; the why and the concepts.
Do not mix them in one section.

## Rules
- Start with what the reader can do after reading, and any prerequisites.
- Show working, copy-pasteable examples; state expected output.
- Use the imperative for steps ("Run...", "Add..."). Keep steps atomic and ordered.
- Define terms once; link rather than repeat.
- Keep it current - call out version-specific behavior.

## Output
Well-structured Markdown with clear headings, code blocks, and a short "next steps" pointer.

Diesen Skill in Shannon AI verwenden

Melden Sie sich an, um diesen Workflow in Ihre eigenen Shannon-Sitzungen zu importieren und mit dem Rest Ihres Workspaces zu kombinieren.

Über Technical Documentation Writer

Technical Documentation Writer ist ein öffentlicher Shannon AI Skill, der von der Community 284-mal geöffnet wurde. Öffentliche Skills sind wiederverwendbare Prompt-Vorlagen, die vor der Übernahme in einen angemeldeten Workspace studiert werden können.

Diese Detailseite wird jetzt nativ in Astro gerendert und zieht ihren Inhalt aus der VPS API, statt eine ganze React-Seitenhülle zu hydrieren.