manual-authoring

Update SNPortal manual prose and release notes from code changes.

Updated Jan 23, 2026
One-click install
npx skills add https://github.com/zdpk/skills --skill manual-authoring
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: manual-authoring
Source: https://github.com/zdpk/skills/tree/main/dotfiles/skills/custom/project/manual-authoring
Command: npx skills add https://github.com/zdpk/skills --skill manual-authoring

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Use when the user wants Codex to write or revise the SNPortal technical manual prose, module summaries, API explanations, architecture notes, release-facing documentation, or other narrative docs under docs/manual and docs/. Use this after deterministic counters have been synced. Do not use for endpoint/schema/table counts alone; use manual-sync for that.

Core Features & Use Cases

  • Draft and revise SNPortal manuals, module summaries, API explanations, and architecture notes to align with code changes.
  • Update release-facing documentation and other narrative docs under docs/ as needed.
  • Use after deterministic counters have been synced to focus prose edits on quality, not numbers.

Quick Start

Run the manual-authoring workflow to update prose based on the latest code changes and approved diffs.

Frequently Asked Questions about manual-authoring

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

FAQPage Schema
How do I keep technical manuals in sync with codebase changes?▼

Updating technical documentation from code changes involves drafting and revising narrative docs like module summaries and architecture notes. The manual-authoring workflow automates this by using repo-local tooling to apply prose updates that track the current code state.

When do I need to update release notes and API reference documentation?▼

You need to update release notes and API reference documentation when code changes alter application behavior. The manual-authoring workflow targets docs/API_REFERENCE.md and release notes, ensuring narrative explanations accurately reflect the latest approved code diffs.

What is the best way to automate prose editing for SNPortal manuals?▼

The best way to automate prose editing for SNPortal manuals is running the manual-authoring workflow. It uses python3 scripts and git commands to resolve base revisions and apply narrative updates across docs/manual.

Does manual-authoring work for updating endpoint and schema counts?▼

No, manual-authoring does not work for updating endpoint and schema counts. It focuses exclusively on narrative prose, module summaries, and architecture notes; use manual-sync for deterministic counters and schema counts.

Do I need git and python3 tooling to manage documentation updates?▼

Yes, you need git and python3 tooling to manage documentation updates. The workflow requires and leverages repo-local scripts like python3 scripts/manual_authoring_context.py and git manual-authoring-commit to resolve revisions and apply updates.

Why should I sync deterministic counters before editing narrative documentation?▼

You should sync deterministic counters before editing narrative documentation to separate quantitative data from qualitative prose. This ensures manual-authoring focuses purely on prose quality, architecture notes, and API explanations without manually counting endpoints.