diataxis-docs-framework
Enterprise technical documentation best practices, patterns, and frameworks for developer and partner adoption. Covers content architecture (Diataxis four quadrants), 14 content types (tutorials, how-to guides, API reference, SDK docs, migration guides, changelogs, runbooks, integration guides, troubleshooting, architecture docs), pluggable writing styles (Diataxis, Google, Microsoft, Stripe, Canonical, Minimal), information architecture, docs-as-code workflows, documentation audit, anti-patterns checklist, and developer experience (DX) strategy. 27 rules, 5 references, 6 style guides. Baseline: Diataxis + Google OpenDocs + Good Docs Project. Triggers on: "write docs", "document this", "API docs", "developer docs", "migration guide", "changelog", "tutorial", "how-to guide", "reference docs", "documentation strategy", "docs audit", "information architecture", "developer experience", "partner docs", "SDK documentation", "runbook", "troubleshooting guide", "integration guide", "quickstart", "getting started", "technical writing", "docs-as-code", "DX", mentions of "Diataxis", "Good Docs Project", or "Google OpenDocs".
Install via CLI (Recommended)
clawhub install openclaw/skills/skills/anivar/developer-docs-frameworkWhat This Skill Does
The diataxis-docs-framework skill provides an expert-level architecture for creating, auditing, and maintaining high-quality technical documentation. It moves beyond generic writing advice by enforcing strict alignment with the Diataxis framework, Google OpenDocs, and The Good Docs Project. It enables you to distinguish between learning-oriented tutorials and task-oriented how-to guides, ensures consistent terminology across API references, and helps structure documentation that improves developer adoption and reduces support overhead. It governs the entire documentation lifecycle—from initial strategy and information architecture to docs-as-code workflows, audits, and partner-facing DX strategy.
Installation
To integrate this documentation framework into your environment, run the following command in your terminal:
clawhub install openclaw/skills/skills/anivar/developer-docs-framework
Use Cases
- Drafting developer-centric content: Create tutorials, API references, or integration guides that follow the specific structural needs of each format.
- Documentation Strategy: Plan the information architecture of a new product by mapping content to the Diataxis quadrants.
- Quality Assurance & Audits: Evaluate existing documentation against the Google OpenDocs maturity model and identify anti-patterns.
- Developer Experience (DX): Standardize onboarding flows for partners and internal teams to minimize the learning curve of your API or SDK.
- Docs-as-Code: Establish governance policies, changelog requirements, and versioning strategies.
Example Prompts
- "Create a structured how-to guide template for an API endpoint authentication process following The Good Docs Project standards."
- "Audit our current SDK documentation against the Diataxis framework and identify which of the four quadrants are missing."
- "Draft a migration guide for users moving from v1 to v2 of our core engine, ensuring it covers breaking changes and deprecated features according to the Google Style Guide."
Tips & Limitations
- Distinguish clearly between tutorials (teaching) and how-to guides (task-completion). Do not mix these roles in a single document.
- Always refer to the style guide prefixes (style-, write-, arch-) when requesting specific outputs to ensure the AI applies the correct framework rules.
- This skill is designed for technical content. It will not perform creative or marketing copywriting; it adheres to the rigor of documentation engineering.
Metadata
Not sure this is the right skill?
Describe what you want to build — we'll match you to the best skill from 16,000+ options.
Find the right skillPaste this into your clawhub.json to enable this plugin.
{
"plugins": {
"official-anivar-developer-docs-framework": {
"enabled": true,
"auto_update": true
}
}
}Tags(AI)
Related Skills
zod-testing
Testing patterns for Zod schemas using Jest and Vitest. Covers schema correctness testing, mock data generation, error assertion patterns, integration testing with API handlers and forms, snapshot testing with z.toJSONSchema(), and property-based testing. Baseline: zod ^4.0.0. Triggers on: test files for Zod schemas, zod-schema-faker imports, mentions of "test schema", "schema test", "zod mock", "zod test", or schema testing patterns.
jest
Jest best practices, patterns, and API guidance for JavaScript/TypeScript testing. Covers mock design, async testing, matchers, timer mocks, snapshots, module mocking, configuration, and CI optimization. Baseline: jest ^29.0.0 / ^30.0.0. Triggers on: jest imports, describe, it, test, expect, jest.fn, jest.mock, jest.spyOn, mentions of "jest", "unit test", "test suite", or "mock".
redux-saga-testing
Write tests for Redux Sagas using redux-saga-test-plan, runSaga, and manual generator testing. Covers expectSaga (integration), testSaga (unit), providers, partial matchers, reducer integration, error simulation, and cancellation testing. Works with Jest and Vitest. Triggers on: test files for sagas, redux-saga-test-plan imports, mentions of "test saga", "saga test", "expectSaga", "testSaga", or "redux-saga-test-plan".
zod
Zod v4 best practices, patterns, and API guidance for schema validation, parsing, error handling, and type inference in TypeScript applications. Covers safeParse, object composition, refinements, transforms, codecs, branded types, and v3→v4 migration. Baseline: zod ^4.0.0. Triggers on: zod imports, z.object, z.string, z.infer, safeParse, mentions of "zod", "schema validation", "zod v4", or "z.enum".
redux-saga
Redux-Saga best practices, patterns, and API guidance for building, testing, and debugging generator-based side-effect middleware in Redux applications. Covers effect creators, fork model, channels, testing with redux-saga-test-plan, concurrency, cancellation, and modern Redux Toolkit integration. Baseline: redux-saga 1.4.2. Triggers on: saga files, redux-saga imports, generator-based middleware, mentions of "saga", "takeEvery", "takeLatest", "fork model", or "channels".