一键在 Manus 中运行任何 Skill

writing-reference

星标131

分支7

更新时间2026年7月2日 11:29

Write Diátaxis reference material, ie information-oriented documentation that neutrally describes a product's machinery (APIs, functions, classes, commands, options, config) for users to consult while working. Use when the reader needs accurate facts to look up, not steps to follow (how-to guide) or background to understand (explanation). Load the `diataxis` skill first if unsure which mode applies.

安装

用 Codex 或 Claude 帮你安装复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。

在 Manus 中运行

来源

mrchantey

mrchantey/beet

打开 GitHub 仓库查看创作者相关仓库

下载

在 Manus 中运行

Writing reference

Reference is a technical description of the machinery and how to operate it. It is information-oriented: propositional, factual knowledge that users consult while they work, not prose they read end to end. Good reference gives users truth and certainty, a firm platform to stand on. Like a map describing territory, it lets a user understand the product without reading the source.

How to write it

Describe, and only describe. This is the one rule. Be austere, neutral, objective, factual. State what the thing is, its parameters, its return values, its options, its limitations, its errors. Do not instruct, explain, persuade, or opine. When the user needs those, link to a how-to guide, tutorial, or explanation.
Mirror the product's structure. Let the shape of the documentation follow the shape of the code or system, so a user can navigate both in parallel. Reference for module X lives in a predictable place relative to module Y.
Be consistent and predictable. Adopt standard patterns and formats and repeat them everywhere. Put information where users expect to find it, in a format they already know. Resist stylistic flourish; predictability is the feature.
State facts directly. "Sub-commands are: a, b, c, d." List features, commands, options, flags, limitations, and error messages. Include necessary warnings. Use plain declarative sentences.
Provide examples. Short usage examples illustrate the facts and show context, without crossing over into instruction.

What to avoid

Letting instruction or explanation creep in. A "describe" that becomes a "do this" has stopped being reference.
Assuming auto-generated docs are sufficient. Generated signatures are a skeleton; the descriptive prose still has to be written and curated.
Mixing in marketing claims or recipes alongside the factual material.

Accuracy

Reference is the mode where accuracy matters most, because users trust it as ground truth and act on it without verifying. Keep it correct and current with the product.

同仓库更多 Skills

同仓库

improving-docs

mrchantey/beet

Audit, restructure, or incrementally improve an existing body of documentation using Diátaxis. Use when the task is to assess docs, untangle mixed-up content, or raise quality across a project rather than write a single new piece. Covers the iterative workflow and how to judge documentation quality. Load the `diataxis` skill to pick a mode, and the writing-* skills to act on each piece.

2026-07-02131

diataxis

mrchantey/beet

Entry point for writing or improving software documentation using the Diátaxis framework. Use this first whenever you are about to write, restructure, or assess docs (README sections, guides, API docs, conceptual articles). It identifies which of the four documentation modes fits the task, then routes you to the matching authoring skill.

2026-07-02131

writing-explanation

mrchantey/beet

Write Diátaxis explanation, ie understanding-oriented documentation that discusses a subject to deepen the reader's grasp of it, covering context, reasons, design decisions, history, and alternatives. Use when the reader wants to understand why and how something is, not to perform a task (how-to guide) or look up facts (reference). Load the `diataxis` skill first if unsure which mode applies.

2026-07-02131

writing-how-to-guides

mrchantey/beet

Write a Diátaxis how-to guide, ie goal-oriented documentation that directs a competent user through the steps to accomplish a specific real-world task. Use when the reader already knows the basics and needs to get something done, not when teaching a beginner (tutorial) or describing the machinery (reference). Load the `diataxis` skill first if unsure which mode applies.

2026-07-02131

writing-tutorials

mrchantey/beet

Write a Diátaxis tutorial, ie learning-oriented documentation that teaches a beginner a skill through a guided, hands-on lesson. Use when the goal is to take someone new and give them a successful first experience, not to solve a specific problem (that is a how-to guide) or to explain concepts (that is explanation). Load the `diataxis` skill first if unsure which mode applies.

2026-07-02131

name

writing-reference

description

Writing reference

How to write it

Describe, and only describe. This is the one rule. Be austere, neutral, objective, factual. State what the thing is, its parameters, its return values, its options, its limitations, its errors. Do not instruct, explain, persuade, or opine. When the user needs those, link to a how-to guide, tutorial, or explanation.
Mirror the product's structure. Let the shape of the documentation follow the shape of the code or system, so a user can navigate both in parallel. Reference for module X lives in a predictable place relative to module Y.
Be consistent and predictable. Adopt standard patterns and formats and repeat them everywhere. Put information where users expect to find it, in a format they already know. Resist stylistic flourish; predictability is the feature.
State facts directly. "Sub-commands are: a, b, c, d." List features, commands, options, flags, limitations, and error messages. Include necessary warnings. Use plain declarative sentences.
Provide examples. Short usage examples illustrate the facts and show context, without crossing over into instruction.

What to avoid

Letting instruction or explanation creep in. A "describe" that becomes a "do this" has stopped being reference.
Assuming auto-generated docs are sufficient. Generated signatures are a skeleton; the descriptive prose still has to be written and curated.
Mixing in marketing claims or recipes alongside the factual material.

Accuracy

Reference is the mode where accuracy matters most, because users trust it as ground truth and act on it without verifying. Keep it correct and current with the product.