cratis-engineering-docs-authoring

Name: cratis-engineering-docs-authoring
Availability: InStock
Author: Cratis

Drafts accurate Cratis documentation pages following Diátaxis document types and verified product sources.

3|Updated Dec 25, 2024

Search Tags:#documentation #markdown #technical writing #diataxis #content authoring #starlight #cratis

Ready to run

npx skills add https://github.com/Cratis/Samples --skill cratis-engineering-docs-authoring-cratis

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: cratis-engineering-docs-authoring
Source: https://github.com/Cratis/Samples/tree/main/.cratis/ai/skills/cratis-engineering-docs-authoring
Command: npx skills add https://github.com/Cratis/Samples --skill cratis-engineering-docs-authoring-cratis

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing technical documentation for Cratis products risks inaccurate API claims, mixed document types, and inconsistent formatting. This Skill drafts one documentation page at a time with verified product facts, the correct Diátaxis structure, and the Cratis site format. ## Core Features & Use Cases - Diátaxis-typed drafting: Produces tutorials, how-to guides, explanations, or reference pages without mixing types on one page. - Source-verified content: Requires first-party product evidence for every API, command, and version claim, and refuses to invent unsupported details. - Site format compliance: Applies Astro Starlight conventions such as frontmatter, heading levels, tagged code fences, and Mermaid diagrams via the bundled format reference. - Use Case: After deciding that a new how-to guide belongs in the Chronicle repository, use this Skill to draft the page content with verified commands, a completion check, and correct Starlight formatting. ## Quick Start Draft a how-to guide page for the Chronicle event store explaining how to append an event, using the verified product source I provide.

Frequently Asked Questions about cratis-engineering-docs-authoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I write Cratis documentation that matches the site format?▼

Draft the page with title and description frontmatter, start body sections at H2, tag every code fence with its language, and use Mermaid for architecture explanations. The bundled site-format reference lists the full Astro Starlight rules.

What is the difference between a tutorial, how-to, explanation, and reference page?▼

A tutorial guides a learner through a complete outcome, a how-to solves one concrete problem, an explanation covers concepts and trade-offs, and a reference lists exact fields and commands. This Skill writes one type per page and never mixes them.

Does this Skill decide where a new documentation page goes?▼

No. Page placement, navigation wiring, and locating existing pages are deferred to companion workflows such as docs-add-page and docs-edit-page. This Skill only drafts content for an already approved destination.

Can it translate C# examples into other client languages?▼

No. It never hand-translates examples into unsupported client languages. Multi-language snippets must use the client-owned snippet mechanism, and every example must be verified against first-party product source.

What happens when a product claim has no source evidence?▼

The Skill stops and identifies the missing authority instead of drafting the claim. It never invents APIs, versions, support commitments, or implementation details that first-party sources cannot prove.