{"id":47714646,"url":"https://github.com/lampd-2157/documentation-skills-toolkit","last_synced_at":"2026-04-02T18:50:25.628Z","repository":{"id":346999668,"uuid":"1192434481","full_name":"lampd-2157/documentation-skills-toolkit","owner":"lampd-2157","description":"Documentation Skills Toolkit — 3 skills, 8 templates, MkDocs-based","archived":false,"fork":false,"pushed_at":"2026-03-27T03:15:20.000Z","size":129,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-27T03:26:21.346Z","etag":null,"topics":["devops","documentation","infrastructure","mkdocs","runbook-automation","templates"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lampd-2157.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-26T08:02:05.000Z","updated_at":"2026-03-27T03:15:23.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/lampd-2157/documentation-skills-toolkit","commit_stats":null,"previous_names":["lampd-2157/documentation-skills-toolkit"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/lampd-2157/documentation-skills-toolkit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lampd-2157%2Fdocumentation-skills-toolkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lampd-2157%2Fdocumentation-skills-toolkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lampd-2157%2Fdocumentation-skills-toolkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lampd-2157%2Fdocumentation-skills-toolkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lampd-2157","download_url":"https://codeload.github.com/lampd-2157/documentation-skills-toolkit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lampd-2157%2Fdocumentation-skills-toolkit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31313435,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["devops","documentation","infrastructure","mkdocs","runbook-automation","templates"],"created_at":"2026-04-02T18:50:25.011Z","updated_at":"2026-04-02T18:50:25.616Z","avatar_url":"https://github.com/lampd-2157.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation Skills Toolkit\n\n![Version](https://img.shields.io/badge/version-5.4.0-blue)\n![Skills](https://img.shields.io/badge/skills-6-green)\n![Templates](https://img.shields.io/badge/templates-14-orange)\n![License](https://img.shields.io/badge/license-MIT-brightgreen)\n\n\u003e **Bộ skill chuẩn hóa cho documentation** — dùng được cho mọi dự án, không phụ thuộc vào bất kỳ hệ thống cụ thể nào.\n\n---\n\n## Toolkit này giải quyết vấn đề gì?\n\n| Vấn đề                                    | Toolkit giải quyết                          |\n| ----------------------------------------- | ------------------------------------------- |\n| Docs rải rác, format không thống nhất     | **5 Skills** chuẩn hóa cách viết mọi loại doc    |\n| Viết doc từ đầu mất thời gian             | **11 Templates** copy-paste, điền nội dung là xong |\n| Không biết viết runbook/guide đúng cách   | Mỗi skill có **Iron Law** + **Guardrails**        |\n| Docs cũ, không ai review                  | **CI/CD pipeline**: lint → review → deploy → audit |\n| Mỗi người viết 1 kiểu                    | **CLI tool** tự tạo doc đúng format chuẩn         |\n\n## Cách hoạt động (3 bước)\n\n**Bước 1: CHỌN SKILL** — Bạn cần viết gì?\n\n| Skill | Khi nào dùng |\n|-------|-------------|\n| `docs-engineer` | Setup MkDocs, chuẩn Markdown |\n| `ops-runbook-writer` | Runbook, network, server docs |\n| `training-doc-writer` | Training, onboarding, curriculum |\n| `project-doc-writer` | ADR, tech spec, how-to, guide |\n| `infra-security-doc` | Security policy, RBAC, audit |\n\n**Bước 2: TẠO DOCUMENT** — Có 2 cách:\n\n| Cách | Workflow |\n|------|---------|\n| **AI Agent** (Recommended) | Copy prompt từ `prompts/` → paste vào AI agent → review |\n| **Manual** | `./scripts/docs-toolkit new runbook \"Tên\"` → đọc skill → điền nội dung |\n\n**Bước 3: VERIFY \u0026 PUBLISH**\n\n```text\nmarkdownlint ✅ → PR review ✅ → mkdocs gh-deploy ✅\n```\n\n\u003e **Lần đầu dùng?** Đọc [Getting Started Guide](docs/getting-started.md) — hướng dẫn chi tiết từ A-Z.\n\u003e\n\u003e **Dùng AI agent?** Xem [Prompt Templates](prompts/) — 13 prompt templates sẵn sàng.\n\n---\n\n## Quick Start\n\n```bash\n# Clone repo\ngit clone https://github.com/lampd-2157/documentation-skills-toolkit.git\ncd documentation-skills-toolkit\n\n# One-command setup (MkDocs + markdownlint + pre-commit)\nbash scripts/setup.sh\n\n# Tạo doc mới từ template\n./scripts/docs-toolkit new runbook \"My Service\"\n\n# Xem demo site\npip install -r demo-site/requirements.txt \u0026\u0026 make serve\n\n# Hoặc dùng Makefile\nmake setup    # One-command setup\nmake serve    # Start dev server\nmake all      # lint + validate + build\n```\n\n---\n\n## 5 Skills\n\nMỗi skill là một **bộ quy tắc** hướng dẫn cách viết 1 loại documentation cụ thể. Tất cả skills tuân thủ cùng cấu trúc 6 sections: Context → Iron Law → Guardrails → Red Flags → Remember → Related Skills.\n\n| Skill | Khi nào dùng | Iron Law (quy tắc tối thượng) |\n|-------|-------------|-------------------------------|\n| [docs-engineer](skills/docs-engineer.md) | Setup MkDocs, chuẩn hóa markdown, chọn plugins | \"Every document MUST pass markdownlint AND render correctly in MkDocs\" |\n| [ops-runbook-writer](skills/ops-runbook-writer.md) | Viết runbook, ops manual, network/server docs | \"Every runbook MUST have copy-paste commands AND expected output\" |\n| [training-doc-writer](skills/training-doc-writer.md) | Viết training, onboarding, curriculum, learning path | \"Every training doc MUST have Prerequisites → Steps → Expected Result → Troubleshooting\" |\n| [project-doc-writer](skills/project-doc-writer.md) | Viết ADR, tech spec, how-to guide, quick reference | \"Every project doc MUST have Context → Decision/Steps → Consequences/Result\" |\n| [infra-security-doc](skills/infra-security-doc.md) | Viết security policy, RBAC, audit log, vulnerability | \"Every security doc MUST have Scope → Policy → Enforcement → Audit\" |\n\n## 11 Templates (T1-T11)\n\nCopy-paste từ [templates/](templates/), hoặc dùng CLI:\n\n| ID  | Template            | CLI command | Use Case |\n| --- | ------------------- | ----------- | -------- |\n| T1  | Runbook             | `docs-toolkit new runbook \"Name\"` | Vận hành hệ thống |\n| T2  | ADR (Nygard)        | `docs-toolkit new adr \"Decision\"` | Architecture decision |\n| T3  | How-to Guide        | `docs-toolkit new howto \"Task\"` | Hướng dẫn step-by-step |\n| T4  | Training Module     | `docs-toolkit new training \"Topic\"` | Training nội bộ |\n| T5  | Network Topology    | `docs-toolkit new network \"Env\"` | Document network infrastructure |\n| T6  | Incident Postmortem | `docs-toolkit new postmortem \"Title\"` | Phân tích sau sự cố |\n| T7  | Maintenance Window  | `docs-toolkit new maintenance \"Title\"` | Kế hoạch bảo trì |\n| T8  | Release Notes       | `docs-toolkit new release-notes \"vX.Y\"` | Tóm tắt version release |\n| T9  | ADR (MADR)          | `docs-toolkit new adr-madr \"Decision\"` | Complex decision, nhiều options |\n| T10 | ADR (Lightweight)   | Copy `templates/adr-lightweight.md` | Quick decision, POC |\n| T11 | Knowledge Check     | `docs-toolkit new knowledge-check \"Topic\"` | Kiểm tra kiến thức |\n\n---\n\n## Tooling\n\n| Tool | Command | Mô tả |\n|------|---------|-------|\n| Scaffold | `./scripts/docs-toolkit new \u003ctype\u003e \u003ctitle\u003e` | Tạo doc mới từ template |\n| Validate | `python3 scripts/validate_skill.py` | Kiểm tra cấu trúc skill file |\n| Lint | `npx markdownlint-cli2 \"**/*.md\"` | Kiểm tra markdown format |\n| Spell | `npx cspell \"**/*.md\"` | Kiểm tra chính tả |\n| Preview | `make serve` | Xem trước trên localhost:8000 |\n| Score | `python3 scripts/score_docs.py` | Chấm điểm chất lượng doc (6 criteria) |\n| Build | `mkdocs build --strict` | Build production |\n\n---\n\n## Project Structure\n\n```text\ndocumentation-skills-toolkit/\n├── skills/                    # 5 skills + template + AGENT-CARDS.json\n├── templates/                 # 11 document templates (T1-T11), individual files\n├── prompts/                   # 13 prompt templates cho AI agent\n├── docs/                      # Guides: getting-started, lifecycle, recipes...\n├── config/                    # Configs: markdownlint, cspell, pre-commit...\n├── examples/                  # Starter configs cho project khác (mkdocs, CI, snippets)\n├── scripts/                   # CLI tools: setup.sh, docs-toolkit, validate_skill.py\n├── evals/                     # Eval test suite cho mỗi skill\n├── demo-site/                 # MkDocs demo site\n├── .github/workflows/         # CI/CD: lint + validate + build\n├── Makefile                   # make serve/lint/validate/build\n├── README.md / CHANGELOG.md / CONTRIBUTING.md / LICENSE\n```\n\n---\n\n## Tài liệu \u0026 Hướng dẫn\n\n| Doc | Mô tả | Đọc khi... |\n|-----|-------|-------------|\n| [Getting Started](docs/getting-started.md) | Hướng dẫn từ A-Z cho người mới | Lần đầu dùng toolkit |\n| [Walkthrough](docs/walkthrough-first-doc.md) | Step-by-step tạo document đầu tiên | Muốn làm theo ví dụ cụ thể |\n| [Lifecycle Guide](docs/docs-lifecycle.md) | Write → Lint → Review → Publish → Audit | Setup Docs-as-Code pipeline |\n| [Composition Recipes](docs/skill-composition-recipes.md) | Kết hợp skills cho task thực tế | Không biết dùng skill nào |\n| [Quality Scorecard](docs/doc-quality-scorecard.md) | Chấm điểm chất lượng doc (0-10) | Review / audit docs |\n| [Anti-Patterns](docs/doc-anti-patterns.md) | 10 lỗi documentation phổ biến | Tránh sai lầm khi viết |\n| [Plugin Catalog](docs/mkdocs-plugins-catalog.md) | MkDocs plugins chọn lọc | Mở rộng MkDocs site |\n| [Infra Knowledge Base](docs/infra-knowledge-base.md) | Cấu trúc docs cho team infra | Team infra/ops mới bắt đầu |\n| [ADR Catalog](docs/adr-catalog.md) | Chọn ADR format + lifecycle + naming | Viết architecture decision |\n| [Incident Patterns](docs/incident-patterns.md) | Failure taxonomy + prevention controls | Phân tích incident/postmortem |\n| [Training Assessment](docs/training-assessment-guide.md) | Bloom's Taxonomy + assessment design | Thiết kế bài kiểm tra |\n| [Diátaxis Mapping](docs/diataxis-mapping.md) | Map toolkit → Diátaxis framework | Organize docs theo chuẩn quốc tế |\n| [Prompt Templates](prompts/) | Prompt chuẩn cho AI agent tạo docs | Dùng AI tạo docs |\n| [Security Placeholders](docs/security-placeholders.md) | Quy chuẩn placeholder cho sensitive data | Docs chứa IPs, passwords, tokens |\n| [Case Study: Ansible](docs/case-study-ansible-network.md) | Ví dụ thực tế v5.0.0 workflow end-to-end (Smart Routing + Interview) | Xem toolkit hoạt động thế nào |\n| [AGENTS.md](AGENTS.md) | Agent context file (tool-agnostic) | AI agent đọc trước khi làm việc |\n| [Routing Playground](docs/routing-playground.md) | Test Smart Routing với natural language input | Hiểu cách routing hoạt động |\n| [Contributing](CONTRIBUTING.md) | Cách đóng góp skills \u0026 templates | Muốn thêm skill/template mới |\n| [Community Skills](skills/community/) | Marketplace cho community-contributed skills | Muốn đóng góp skill mới |\n\n---\n\n## License\n\nMIT — [LICENSE](LICENSE)\n\n\u003e **Created by [DulapReal](https://github.com/lampd-2157)** — Infrastructure \u0026 Automation Engineer\n\u003e\n\u003e Version 5.4.0 | 2026-03-30\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flampd-2157%2Fdocumentation-skills-toolkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flampd-2157%2Fdocumentation-skills-toolkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flampd-2157%2Fdocumentation-skills-toolkit/lists"}