Hai Audit Docs logo

Hai Audit Docs

Community
hylarucoder
hai-audit-docs

Audits documentation for internal contradictions and/or mismatches with code, config, schemas, and approved contracts. Use for 文档审计、前后冲突、术语漂移、README 是否过时、文档和代码一致吗, including check-and-fix requests. Select evidence sources from the request; return prioritized findings, source precedence, and repair ownership. Apply clear local repairs only when requested. Use hai-rewrite-doc for wholesale reconstruction, hai-prd for product shaping, and readme-beautifier for formatting only.

Overview

Publisherhylarucoder
Repositoryhai-stack
Skill namehai-audit-docs
Stars
284
Forks
15
Bundled files
6
Links
  • 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.

  • 6 bundled files

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

  • Open source

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

Installation

Install the Hai Audit Docs 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/hylarucoder/hai-stack.git /tmp/hai-stack
mkdir -p .claude/skills
cp -r /tmp/hai-stack/skills/hai-audit-docs .claude/skills/hai-audit-docs
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Hai Audit Docs 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 Hai Audit Docs 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 Hai Audit Docs 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.

Hai Audit Docs

For Chinese readers, see SKILL.zh_CN.md. The English file is the execution source of truth.

Principle

A coherent document can be factually wrong; implementation can violate an approved requirement. Declare which authority settles each claim before deciding which side needs repair.

Select evidence and action

  • Internal: compare claims within the named document set. Respect "only docs/no code". Internal agreement proves consistency, not runtime truth.
  • Implementation/contract: compare current-behavior claims with code/config and intended behavior with approved specs/contracts. Inspect related internal contradictions as useful.
  • Combined: use both when the user asks for both or a general accuracy audit has both sources available. State the chosen scope; if code is unavailable, mark claims unverified instead of implying they match.
  • Audit only: deliver findings without editing.
  • Check and fix: when requested, apply evidence-backed repairs to the named local documents, then recheck affected claims and links. Do not silently change implementation to make docs true. Escalate unresolved product/authority choices; continue independent clear repairs.

These are internal modes, not questions the user must answer before work starts.

Workflow

  1. Identify the named document surface, audience, scenarios, and requested action. Do not expand named targets into sibling documents without reason or authorization. With no named targets, inspect README, setup/API docs, and examples relevant to the question.
  2. Build a claim map: behavior, commands, defaults, lifecycle, permissions, terminology, assumptions, acceptance, and cross-links. Record source precedence per class of claim.
  3. For internal evidence, read references/internal-audit.md; distinguish explicit supersession from unsupported claims. Absence of support alone does not prove a claim false or obsolete.
  4. For implementation evidence, read references/checklist.md. Trace documented scenarios to implementation and inspect public/config contracts back toward documentation for important omissions. Cite both locations and identify generated versus canonical sources.
  5. Classify each finding as document defect, implementation gap, internal conflict, or needs evidence/decision. If a doc describes approved future behavior, mark the implementation gap; do not rewrite it to bless current behavior. Consult references/worked-examples.md when authority is disputed.
  6. Recommend update, move, merge, remove, split, or resolve. Separate a suggested repair from an applied edit. Preserve real contracts and unresolved claims explicitly.
  7. If repairs were requested, make the bounded authorized edits and verify them. Route a wholesale rewrite to hai-rewrite-doc with the established evidence; product decisions belong to hai-prd, plan changes to hai-goal.
  8. Read references/output-template.md and report scope, findings, actual edits, verification, and unresolved decisions without repeating a full report for each evidence mode.

Impact

  • P0: evidenced severe wrong decision, data/security harm, or launch failure.
  • P1: core scenario, scope, or acceptance is materially wrong.
  • P2: bounded drift, omission, duplication, or misleading terminology.
  • P3: minor wording or link issue.
  • Needs evidence/decision: unresolved; not a confirmed defect.

Rate actual impact, not the presence of a sensitive keyword. A security-related typo alone does not become a release blocker.

Boundaries

  • Formatting without factual changes → readme-beautifier.
  • Whole-document reconstruction → hai-rewrite-doc.
  • Product requirements or acceptance definition → hai-prd.
  • Entity fields and storage/migration placement → entity-model-auditor.
  • Proving a software change works → write-technical-acceptance-report; documentation inspection alone does not prove runtime acceptance.

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 Hai Audit Docs AI skill do?

Audits documentation for internal contradictions and/or mismatches with code, config, schemas, and approved contracts. Use for 文档审计、前后冲突、术语漂移、README 是否过时、文档和代码一致吗, including check-and-fix requests. Select evidence sources from the request; return prioritized findings, source precedence, and repair ownership. Apply clear local repairs only when requested. Use hai-rewrite-doc for wholesale reconstruction, hai-prd for product shaping, and readme-beautifier for formatting only.

Why use Hai Audit Docs on TypingMind?

Because you install it once and use it with any model. Hai Audit Docs 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 Hai Audit Docs in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/hylarucoder/hai-stack/tree/main/skills/hai-audit-docs. 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 Hai Audit Docs?

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 Hai Audit Docs?

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

Is the Hai Audit Docs AI skill free?

It is published on GitHub by hylarucoder. 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.

View all

Set up your own AI workspace now

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