mit einem Klick
beet
beet enthält 6 gesammelte Skills von mrchantey, mit Repository-Berufsabdeckung und Skill-Detailseiten auf SkillsMP.
Skills in diesem Repository
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.
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.
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.
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.
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.
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.