Docs Manuals logo

Docs Manuals

Community
jh941213
docs-manuals

Generate user manuals (Diátaxis) and operator manuals (runbooks, deployment guide, configuration reference, incident playbook). Use when writing user manuals/guides/tutorials, operator manuals, runbooks, deployment guides, on-call/incident response docs. API specs → docs-interfaces; architecture docs → docs-architecture; docs CI pipeline → docs-ci

Overview

Publisherjh941213
Repositorymy-cc-harness
Skill namedocs-manuals
Stars
125
Forks
35
Bundled files
1
Links
Skill sourceRepository
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 1 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by jh941213 on GitHub. Read the source before you install it.

Installation

Install the Docs Manuals AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/jh941213/my-cc-harness.git /tmp/my-cc-harness
mkdir -p .claude/skills
cp -r /tmp/my-cc-harness/skills_en/docs-manuals .claude/skills/docs-manuals
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Docs Manuals in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Docs Manuals on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Docs Manuals is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

User/Operator Manual Skill

Writes for the actual reader (end user vs operator) in their actual situation (learning vs firefighting).

Input

$ARGUMENTS

User manual — the Diátaxis quadrants

Cardinal rule: never mix two modes in one page. Classify before writing:

QuadrantPurposeFormLocation
TutorialLearning (newcomers)A lesson that succeeds when followed. One path, no choicesdocs/manuals/tutorials/
How-toSolving a task ("how do I X?")Goal-oriented steps. Prerequisites stateddocs/manuals/how-to/
ReferenceLooking things upDictionary-like. Mirrors the product's structuredocs/manuals/reference/
ExplanationUnderstanding ("why is it like this?")Background, design reasons, trade-offsdocs/manuals/explanation/

Trigger mapping: new feature → how-to + reference / new concept → explanation / onboarding gap → tutorial

Index at docs/manuals/README.md — navigation organized by the four quadrants.

Operator manual

Location: docs/ops/

1. Operations overview (docs/ops/README.md)

  • System topology (link/include the deployment diagram from docs-architecture)
  • Capacity/scaling notes, steady-state metric baselines

2. Configuration reference (docs/ops/configuration.md)

Every env var/flag in a table — extracted from code (.env.example, config files, process.env/os.environ grep):

NameTypeDefaultEffectValid values

3. Runbooks (docs/ops/runbooks/[alert-name].md)

Someone seeing this for the first time at 3 a.m. must be able to follow it. Template: templates/runbook.md

  • One file per alert: alert name/severity/user impact → diagnosis (dashboard links + paste-ready queries) → mitigation (ordered paste-ready commands + trade-off warnings per step) → root fix/follow-up → escalation path
  • A new alert rule ships with its runbook in the same PR. A runbook used in an incident gets updated afterward, always

4. Deployment guide (docs/ops/deployment.md)

Environments, pipeline description, rollout procedure, post-deploy verification (smoke check commands), rollback procedure (the most important part — paste-ready)

5. Incident playbook (docs/ops/incident-playbook.md)

Severity matrix, roles (incident commander/comms lead), comms templates, escalation policy, blameless postmortem template

Procedure

  1. Determine target: user docs vs ops docs, specific doc vs full set
  2. Collect sources: code (config/alert rules/deploy scripts), existing docs/, CI config, docker/k8s manifests
  3. State only facts confirmed in code — unknown operational values (dashboard URLs, on-call rotations) get <!-- TODO: confirm with ops --> markers and a reported list
  4. Update existing docs with Edit; Write only new ones
  5. Update the docs/docs.yaml manifest
  6. Prose in the project language; commands/identifiers verbatim

Constraints

  • Modify only docs/
  • Runbook commands must actually run — no nonexistent scripts/commands
  • One Diátaxis quadrant per page — propose a split when mixing is detected

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Docs Manuals AI skill do?

Generate user manuals (Diátaxis) and operator manuals (runbooks, deployment guide, configuration reference, incident playbook). Use when writing user manuals/guides/tutorials, operator manuals, runbooks, deployment guides, on-call/incident response docs. API specs → docs-interfaces; architecture docs → docs-architecture; docs CI pipeline → docs-ci

Why use Docs Manuals on TypingMind?

Because you install it once and use it with any model. Docs Manuals is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Docs Manuals in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/jh941213/my-cc-harness/tree/main/skills_en/docs-manuals. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Docs Manuals?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Docs Manuals?

As many as you like. As long as a model supports skills, you can use Docs Manuals with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Docs Manuals AI skill free?

It is published on GitHub by jh941213. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

Related AI Skills

View all
JuliusBrussee logo

Caveman Compress

JuliusBrussee
CommunityPopular

Compress a memory file such as CLAUDE.md or a todo list into caveman format to save input tokens, keeping a readable backup. Trigger: /caveman-compress.

6.2K
106.3K
7 files
View
JuliusBrussee logo

Caveman Discover

JuliusBrussee
CommunityPopular

Find and label every LLM workflow in the repository so Caveman Cloud groups spend by workflow instead of one bucket. Use for "discover workflows" or breaking LLM spend down by workflow.

6.2K
106.3K
Instructions
View
JuliusBrussee logo

Caveman Manage

JuliusBrussee
CommunityPopular

Inspect Caveman Cloud's experiment lifecycle and block unsafe execution. Use when asked to start, approve, cancel, promote or roll back a Caveman experiment.

6.2K
106.3K
Instructions
View
JuliusBrussee logo

Caveman Setup

JuliusBrussee
CommunityPopular

Wire a repository through the Caveman Cloud gateway so every LLM request is measured, with no behavior change. Use for "set up caveman" or adding LLM spend observability.

6.2K
106.3K
Instructions
View

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇