[Extension]: Add User Manual #5260

Extension ID

user-manual

Extension Name

User Manual

Version

2.0.4

Description

Create and incrementally maintain bilingual-ready, audience-aware application manuals in Markdown that reads correctly on GitHub, rendered as Markdown, through your own templates and tools, or as...

Author

Samy K. Abushanab

Repository URL

https://github.com/samykabu/sanduq

Download URL

https://github.com/samykabu/sanduq/releases/download/user-manual-v2.0.4/user-manual.zip

License

MIT

Homepage (optional)

https://github.com/samykabu/sanduq/tree/main/extensions/user-manual

Documentation URL (optional)

https://github.com/samykabu/sanduq/blob/main/docs/extensions/user-manual.md

Changelog URL (optional)

https://github.com/samykabu/sanduq/blob/main/extensions/user-manual/CHANGELOG.md

Required Spec Kit Version

=0.2.0

Required Tools (optional)

• git (optional)
• python >=3.11 (required)
• node (optional)
  Extensions: illustrate >=2.0.0,<3.0.0 (all published in the same catalog, https://raw.githubusercontent.com/samykabu/sanduq/main/catalog.json)

Number of Commands

4

Number of Hooks (optional)

2

Tags

documentation, user-manual, i18n, mkdocs

Key Features

• Creates and maintains an application manual in Markdown that reads correctly on GitHub, with editions per audience (end user, administrator, technical).
• Before implementation, finds the pages, API examples and screenshots a feature changes; after it, updates only the affected pages and builds a private preview.
• Renders each edition as Markdown, through your own command (Pandoc, Quarto, a script), or as an MkDocs site and PDF. English required; Arabic right-to-left optional.

Testing Checklist

• Extension installs successfully via download URL
• All commands execute without errors
• Documentation is complete and accurate
• No security vulnerabilities identified
• Tested on at least one real project

Submission Requirements

• Valid extension.yml manifest included
• README.md with installation and usage instructions
• LICENSE file included
• GitHub release created with version tag
• All command files exist and are properly formatted
• Extension ID follows naming conventions (lowercase-with-hyphens)

Testing Details

Exercised through Sanduq Workflow live runs on Claude Code and Codex on 2026-10-28 (Manual Analyze and Manual Update both ran, bilingual editions). Unit tests (81) and a manual audit of a sample manual run in CI.

Example Usage

/speckit-user-manual-init Discover our modules, interview me about audiences, and require English.
/speckit-user-manual-update --feature specs/412-refund-approval Update only the affected refund pages.

Proposed Catalog Entry

{
  "user-manual": {
    "name": "User Manual",
    "id": "user-manual",
    "version": "2.0.4",
    "description": "Create and incrementally maintain bilingual-ready, audience-aware application manuals in Markdown that reads correctly on GitHub, rendered as Markdown, through your own templates and tools, or as MkDocs HTML and PDF, including modules, interfaces, tutorials, screenshots, APIs, releases, migrations, infrastructure, architecture, and complete data dictionaries.",
    "author": "Samy K. Abushanab",
    "repository": "https://github.com/samykabu/sanduq",
    "homepage": "https://github.com/samykabu/sanduq/tree/main/extensions/user-manual",
    "documentation": "https://github.com/samykabu/sanduq/blob/main/extensions/user-manual/README.md",
    "changelog": "https://github.com/samykabu/sanduq/blob/main/extensions/user-manual/CHANGELOG.md",
    "download_url": "https://github.com/samykabu/sanduq/releases/download/user-manual-v2.0.4/user-manual.zip",
    "license": "MIT",
    "category": "documentation",
    "effect": "read-write",
    "requires": {
      "speckit_version": ">=0.2.0",
      "extensions": [
        {
          "id": "illustrate",
          "version": ">=2.0.0,<3.0.0",
          "required": true
        }
      ],
      "tools": [
        {
          "name": "git",
          "required": false
        },
        {
          "name": "python",
          "required": true,
          "version": ">=3.11"
        },
        {
          "name": "node",
          "required": false
        }
      ]
    },
    "provides": {
      "commands": 4,
      "hooks": 2
    },
    "tags": [
      "user-manual",
      "documentation",
      "mkdocs",
      "material",
      "pdf",
      "bilingual",
      "arabic",
      "rtl",
      "api",
      "tutorial",
      "release-notes",
      "migration-guide",
      "screenshots",
      "architecture",
      "infrastructure",
      "data-dictionary"
    ],
    "verified": false,
    "created_at": "2026-07-18T18:35:58Z",
    "updated_at": "2026-11-05T20:38:48.563726+00:00",
    "sha256": "25b43f3e268f93bca7f396ed8e54fa0505bbbe5752bc34f05bf9f0f9f485e684"
  }
}

Additional Context

One of the Sanduq extensions (https://github.com/samykabu/sanduq), all MIT. The full set is also published in its own catalog: https://raw.githubusercontent.com/samykabu/sanduq/main/catalog.json. The ids scope and memory from the same repository are not submitted because the community catalog already has unrelated extensions with those ids.