Back to Details

user-manual

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

User Manual

用户手册

Maintain one evidence-backed documentation source under 
User-Manual/
and publish filtered editions for end users, administrators/operators, and technical readers.
在
User-Manual/
目录下维护一个基于证据的单一文档源，并为终端用户、管理员/运维人员及技术读者发布经过筛选的版本。

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
    .
  • 新手册或模块探索：阅读discovery.md。
  • 页面结构与内容类型：阅读content-model.md。
  • 受众或语言写作规范：阅读audience-language.md。
  • 功能更新：阅读incremental-update.md。
  • 实体、列、枚举或ER图：阅读data-reference.md。
  • 主题、HTML、PDF、RTL、预览或发布构建：阅读publishing.md。
  • API相关工作：加载
    ../api-docs/SKILL.md
    。
  • 发布说明或迁移指南：加载
    ../release-docs/SKILL.md
    。
  • UI截图：加载
    ../ui-screenshots/SKILL.md
    。
  • 已批准的托管预览：加载
    ../preview-publishing/SKILL.md
    。

Non-negotiable rules

不可协商的规则

  1. Require English. Treat Arabic as project-optional while keeping every template RTL-ready.
  2. Use plain, natural English or Arabic. Match vocabulary, detail, risks, and examples to the page's declared audience.
  3. Ground claims in specifications, implementation, contracts, tests, observed development behavior, schema metadata, or approved infrastructure sources. Mark unknowns; never invent them.
  4. Never include secret values, credentials, tokens, private keys, connection strings, production records, or unredacted personal data.
  5. Store the approved module map in 
    User-Manual/manual.yml
    . Add later discoveries as 
    proposed
    until approved.
  6. Keep Markdown canonical. Generate HTML, archives, and PDF through scripts.
  7. Generate only useful diagrams. Reuse Illustrate and keep system overviews separate from readable module-level detail.
  8. Preserve hand-authored content outside owned markers and converge on rerun.
  1. 要求使用英文。阿拉伯语为项目可选语言，但需确保所有模板支持RTL（从右到左）布局。
  2. 使用简洁自然的英文或阿拉伯语。根据页面声明的受众匹配词汇、细节、风险说明及示例。
  3. 所有内容需基于规格说明、实现代码、合同、测试、已观察到的开发行为、元数据架构或已批准的基础设施来源。标注未知内容，切勿编造。
  4. 禁止包含机密值、凭证、令牌、私钥、连接字符串、生产记录或未编辑的个人数据。
  5. 将已批准的模块映射存储在
    User-Manual/manual.yml
    中。后续发现的内容需标记为
    proposed
    （待批准）状态，直至获得批准。
  6. 以Markdown作为标准格式。通过脚本生成HTML、归档文件及PDF。
  7. 仅生成有用的图表。复用Illustrate工具，并将系统概览与可读的模块级细节分开呈现。
  8. 保留标记范围外的人工编写内容，并在重新运行时保持内容一致。