human-facing-docs

Name: human-facing-docs
Author: TheModdersDen

Keep human-facing product docs concise and focused on user-visible changes.

by TheModdersDen(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from TheModdersDen/SillyTavern-xUtils (.github/instructions/human-facing-docs.instructions.md). Copyright stays with the author.

Maintenance: Last reviewed 2026-05-18. Update when changelog or README authoring expectations change.

Scope

Treat CHANGELOG.md and readme.md as human-facing documents.
Keep edits concise, direct, and easy to scan.

Content Rules

Describe user-visible features, fixes, and behavior changes.
Omit internal refactors, build changes, and implementation-only details unless they change user-facing behavior.
Prefer outcome-focused wording over internal process wording.

File-Specific Guidance

In CHANGELOG.md, add short entries that explain what users can now do, what changed, or what was fixed.
In readme.md, update only user-relevant guidance, behavior, or examples affected by the change.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/themoddersden-sillytavern-xutils-human-facing-docs-instructions/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

themoddersden-sillytavern-xutils-human-facing-docs-instructions.ocm.jsonjson

{
  "ocm": "1",
  "id": "themoddersden-sillytavern-xutils-human-facing-docs-instructions",
  "kind": "skill",
  "name": "human-facing-docs",
  "description": "Keep human-facing product docs concise and focused on user-visible changes.",
  "publisher": "TheModdersDen",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Keep human-facing product docs concise and focused on user-visible changes."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/TheModdersDen/SillyTavern-xUtils",
      "path": ".github/instructions/human-facing-docs.instructions.md",
      "ref": "60ab9eb7ce064b4d8f491f832def570848e8b950",
      "url": "https://github.com/TheModdersDen/SillyTavern-xUtils/blob/60ab9eb7ce064b4d8f491f832def570848e8b950/.github/instructions/human-facing-docs.instructions.md",
      "key": "TheModdersDen/SillyTavern-xUtils/.github/instructions/human-facing-docs.instructions.md"
    },
    "applies_to": "CHANGELOG.md,readme.md"
  },
  "instructions": "Maintenance: Last reviewed 2026-05-18. Update when changelog or README authoring expectations change.\n\n## Scope\n\n- Treat `CHANGELOG.md` and `readme.md` as human-facing documents.\n- Keep edits concise, direct, and easy to scan.\n\n## Content Rules\n\n- Describe user-visible features, fixes, and behavior changes.\n- Omit internal refactors, build changes, and implementation-only details unless they change user-facing behavior.\n- Prefer outcome-focused wording over internal process wording.\n\n## File-Specific Guidance\n\n- In `CHANGELOG.md`, add short entries that explain what users can now do, what chan",
  "cost": {
    "context_tokens": 180
  }
}

Fetch it by URL: GET /api/v1/registry/themoddersden-sillytavern-xutils-human-facing-docs-instructions/manifest?version=1.0.0