user-manual

Original：🇺🇸 English

Translated

Create, organize, incrementally update, validate, and publish a complete application User Manual for web, mobile, API, infrastructure, architecture, and data surfaces. Use for UserManual.Init, Analyze, Update, or Release; MkDocs/Material documentation; bilingual English and Arabic manuals; audience editions; tutorials; system documentation; diagrams; and documentation coverage.

2installs

Sourcesamykabu/sanduq

Added on2026-08-15

NPX Install

npx skill4agent add samykabu/sanduq user-manual

SKILL.md Content

View Translation Comparison →

User Manual

Maintain one evidence-backed documentation source under

User-Manual/

and publish filtered editions for end users, administrators/operators, and technical readers.

Route only what is needed

New manual or module discovery: read discovery.md.
Page structure and content type: read content-model.md.
Audience or language writing: read audience-language.md.
Feature update: read incremental-update.md.
Entities, columns, enumerations, or ER diagrams: read data-reference.md.
Theme, HTML, PDF, RTL, preview, or release build: read publishing.md.
API work: load
```
../api-docs/SKILL.md
```
.
Release notes or migration guides: load
```
../release-docs/SKILL.md
```
.
UI screenshots: load
```
../ui-screenshots/SKILL.md
```
.
Approved hosted preview: load
```
../preview-publishing/SKILL.md
```
.

Non-negotiable rules

Require English. Treat Arabic as project-optional while keeping every template RTL-ready.
Use plain, natural English or Arabic. Match vocabulary, detail, risks, and examples to the page's declared audience.
Ground claims in specifications, implementation, contracts, tests, observed development behavior, schema metadata, or approved infrastructure sources. Mark unknowns; never invent them.
Never include secret values, credentials, tokens, private keys, connection strings, production records, or unredacted personal data.
Store the approved module map in
```
User-Manual/manual.yml
```
. Add later discoveries as
```
proposed
```
until approved.
Keep Markdown canonical. Generate HTML, archives, and PDF through scripts.
Generate only useful diagrams. Reuse Illustrate and keep system overviews separate from readable module-level detail.
Preserve hand-authored content outside owned markers and converge on rerun.