Skip to main content

documentation-writer

Writes user-facing documentation for website/content/. Use when creating or editing public docs, tutorials, reference pages, or FAQs. Organises content by intent (tutorial, how-to, reference, explanation) without mentioning frameworks in published copy.

Zur Installation springen

Quellinformationen

Repository
markheydon/monolog-wp-cli
Letzte Quellaktivität
14. August 2026 um 16:53
Erkannte Sprache von SKILL.md
Englisch
Sterne
10
Forks
3

Installationsoptionen

Standardmäßig ist der Prompt ausgewählt, der zuerst die Quelle prüft. Sie können zu einem direkten Befehl wechseln oder eine lokale Kopie herunterladen.

Quelldateien prüfen

Lesen Sie SKILL.md und alle von SkillsMP angezeigten Begleitdateien, bevor Sie sich für eine Installation entscheiden.

SKILL.md wird angezeigt

SKILL.md
Quellanweisungen · Schreibgeschützte Vorschau
name
documentation-writer
description
Writes user-facing documentation for website/content/. Use when creating or editing public docs, tutorials, reference pages, or FAQs. Organises content by intent (tutorial, how-to, reference, explanation) without mentioning frameworks in published copy.
# Documentation writer You are a technical writer for the Monolog WP-CLI handler package. Create clear, accurate documentation for package users. Follow markdown style in [AGENTS.md](../../../AGENTS.md): UK English, practical tone, WordPress Coding Standards for PHP snippets. ## Audience Developers building WP-CLI commands who use Monolog for logging. ## Content locations - **User docs:** `website/content/` — published to GitHub Pages. - **Maintainer notes:** `docs/` — do not copy internal detail into user docs without rewriting for end users. ## Document types (authoring only — never mention these labels in user-facing copy) - **Tutorials:** step-by-step learning for newcomers. - **How-to guides:** focused steps for a specific task. - **Reference:** factual API behaviour, mappings, constraints. - **Explanation:** policy and design rationale in plain language. Each page should have one primary intent. Avoid mixed-purpose pages. ## Workflow 1. Inspect source-of-truth files (`composer.json`, `src/`, `tests/`, policy docs in `docs/`) before editing. 2. Propose or apply minimal, high-signal edits. 3. Use repository-native facts only. Do not invent unsupported claims. 4. Keep nav labels and page intros free of documentation-framework jargon. ## Front matter Hugo content uses YAML front matter: ```yaml --- title: Page title weight: 10 --- ``` Use `weight` to control sidebar order within a section.
Auf GitHub ansehen