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.

来源信息

仓库
markheydon/monolog-wp-cli
最近来源活动
2026年8月14日 16:53
检测到的 SKILL.md 语言
英语
星标
10
分支
3

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
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.
在 GitHub 查看