ln-115-devops-docs-creator
Creates infrastructure.md (always) and runbook.md (if hasDocker). DevOps documentation worker.
- License 许可
- MIT
- 最近更新
- 2026-05-02
- Stars
- ★ 3
- Forks
- 1
01 前言 Front Matter
- name
- ln-115-devops-docs-creator
- license
- MIT
- description
- Creates infrastructure.md (always) and runbook.md (if hasDocker). DevOps documentation worker.
02 资源文件 3
- 参考文档references/questions_devops.md7.9 KB
- 参考文档references/templates/infrastructure_template.md3.5 KB
- 参考文档references/templates/runbook_template.md12.4 KB
03 SKILL.md 正文
Paths: File paths (
shared/,references/,../ln-*) are relative to skills repo root. If not found at CWD, locate this SKILL.md directory and go up one level for repo root.
DevOps Documentation Creator
L3 Worker that creates infrastructure.md and runbook.md. Infrastructure inventory is always created; runbook is conditional on Docker presence.
Purpose & Scope
- Creates infrastructure.md (always) — declarative inventory: WHAT is deployed WHERE
- Creates runbook.md (if hasDocker) — procedural guide: HOW to deploy/restart/troubleshoot
- Receives Context Store from ln-110-project-docs-coordinator
- Never gathers context itself; uses coordinator input
Invocation (who/when)
- ln-110-project-docs-coordinator: ALWAYS invoked (infrastructure.md is unconditional)
- Never called directly by users
Inputs
From coordinator:
contextStore: Context Store with DevOps-specific data- DOCKER_COMPOSE_DEV (development setup)
- DOCKER_COMPOSE_PROD (production setup)
- ENV_VARIABLES (from .env.example)
- STARTUP_SEQUENCE (services order)
- DEPLOYMENT_TARGET (AWS, Vercel, Heroku)
- CI_CD_PIPELINE (from .github/workflows)
- DOCKER_SERVICES (parsed from docker-compose.yml services)
- DEPLOYMENT_SCALE ("single" | "multi" | "auto-scaling" | "gpu-based")
- DEVOPS_CONTACTS (from CODEOWNERS, package.json author, git log)
- HAS_GPU (detected from docker-compose nvidia runtime)
- SERVER_INVENTORY (from SSH config, deploy targets)
- DOMAIN_DNS (from docker-compose VIRTUAL_HOST vars, nginx configs)
- ARTIFACT_REPOSITORY (from .env registry URLs, .npmrc, pip.conf)
- HOST_REQUIREMENTS (from docker-compose deploy.resources.limits)
targetDir: Project root directoryflags: { hasDocker }
Documents Created (2: 1 always + 1 conditional)
| File | Condition | Questions | Auto-Discovery |
|---|---|---|---|
| docs/project/infrastructure.md | Always | Q52-Q55 | Medium |
| docs/project/runbook.md | hasDocker | Q46-Q51 | High |
Workflow
Phase 1: Check Conditions
- Parse flags from coordinator
- infrastructure.md: ALWAYS proceeds (no condition check)
- runbook.md: Create ONLY if
hasDocker=true - If target file already exists: skip that file (idempotent)
Phase 2a: Create infrastructure.md (unconditional)
- Check if
docs/project/infrastructure.mdexists - If exists: skip with log
- If not exists:
- Copy
references/templates/infrastructure_template.md - Replace placeholders with Context Store values
- Populate Server Inventory from SERVER_INVENTORY
- Populate Port Allocation from DOCKER_SERVICES port mappings
- Populate Deployed Services from DOCKER_SERVICES
- Populate CI/CD Pipeline from CI_CD_PIPELINE
- Mark
[TBD: X]for missing data
- Copy
- Conditional Section Pruning:
- If no CI/CD detected: mark CI/CD Pipeline section as
[TBD: Configure CI/CD] - If no ARTIFACT_REPOSITORY: mark Artifact Repository as
[TBD: Configure registry] - If single server / no SERVER_INVENTORY: simplify to single-column table
- If !HAS_GPU: remove GPU column from Server Inventory and Deployed Services
- Populate Deployed Services ONLY from DOCKER_SERVICES (no generic examples)
- If no CI/CD detected: mark CI/CD Pipeline section as
Phase 2b: Create runbook.md (conditional)
- If
!hasDocker: skip entirely - Check if
docs/project/runbook.mdexists - If exists: skip with log
- If not exists:
- Copy
references/templates/runbook_template.md - Replace placeholders with Context Store values
- Populate setup steps from package.json scripts
- Extract env vars from .env.example
- Mark
[TBD: X]for missing data
- Copy
- Conditional Section Pruning:
- If DEPLOYMENT_SCALE != "multi" or "auto-scaling": Remove scaling/load balancer sections
- If !HAS_GPU: Remove GPU-related sections (nvidia runtime, CUDA)
- If service not in DOCKER_SERVICES: Remove that service's examples
- If DEVOPS_CONTACTS empty: Mark as
[TBD: Provide DevOps team contacts via Q50] - Populate service dependencies ONLY from DOCKER_SERVICES
- Populate port mapping ONLY from docker-compose.yml ports section
Phase 3: Self-Validate
For infrastructure.md:
- Check SCOPE tag
- Validate sections: Server Inventory, Port Allocation, Deployed Services
- Check no procedural content leaked (belongs in runbook.md)
- Check Maintenance section
For runbook.md (if created):
- Check SCOPE tag
- Validate sections: Local Development Setup, Deployment, Troubleshooting
- Check env vars documented
- Check Maintenance section
Phase 4: Return Status
{
"created": ["docs/project/infrastructure.md", "docs/project/runbook.md"],
"skipped": [],
"tbd_count": 3,
"validation": "OK"
}
Critical Notes
Core Rules
- infrastructure.md: Always created, no condition
- runbook.md: Conditional on hasDocker
- Heavy auto-discovery: Most data from docker-compose.yml, .env.example, package.json, SSH config
- Reproducible: Setup steps must be testable and repeatable
- Idempotent: Never overwrite existing files
NO_CODE_EXAMPLES Rule (MANDATORY)
Both documents describe inventory/procedures, NOT implementations:
- FORBIDDEN: Full Docker configs, CI/CD pipelines (>5 lines), full nginx configs
- ALLOWED: Command examples (1-3 lines), env var tables, step lists, verification commands
- INSTEAD OF CODE: "See docker-compose.yml"
Stack Adaptation Rule (MANDATORY)
- Commands must match project stack (npm vs pip vs go)
- Link to correct cloud provider docs (AWS/Azure/GCP)
- Never mix stack references (no npm commands in Python project)
Format Priority (MANDATORY)
Tables (env vars, ports, services, servers) > Lists (setup steps) > Text
Definition of Done
- infrastructure.md created (always)
- runbook.md created if hasDocker
- Infrastructure: server inventory, ports, services documented
- Runbook: setup steps, deployment, troubleshooting documented
- All env vars from .env.example included in runbook
- Actuality verified: all document facts match current code (paths, functions, APIs, configs exist and are accurate)
- Status returned to coordinator
Reference Files
- Templates:
references/templates/infrastructure_template.md,references/templates/runbook_template.md - Questions:
references/questions_devops.md(Q46-Q51 runbook, Q52-Q55 infrastructure)
Version: 2.0.0 Last Updated: 2025-01-12
04 同仓库更多 Skills
zarr-python
Chunked N-D arrays for cloud storage. Compressed arrays, parallel I/O, S3/GCS integration, NumPy/Dask/Xarray compatible, for large-scale scientific computing pipelines.
zabbix
Zabbix monitoring system automation via API and Python. Use when: (1) Managing hosts, templates, items, triggers, or host groups, (2) Automating monitoring configuration, (3) Sending data via Zabbix trapper/sender, (4) Querying historical data or events, (5) Bulk operations on Zabbix objects, (6) Maintenance window management, (7) User/permission management
x-twitter-growth
X/Twitter growth engine for building audience, crafting viral content, and analyzing engagement. Use when the user wants to grow on X/Twitter, write tweets or threads, analyze their X profile, research competitors on X, plan a posting strategy, or optimize engagement. Complements social-content (generic multi-platform) with X-specific depth: algorithm mechanics, thread engineering, reply strategy, profile optimization, and competitive intelligence via web search.
what-if-oracle
Run structured What-If scenario analysis with multi-branch possibility exploration. Use this skill when the user asks speculative questions like "what if...", "what would happen if...", "what are the possibilities", "explore scenarios", "scenario analysis", "possibility space", "what could go wrong", "best case / worst case", "risk analysis", "contingency planning", "strategic options", or any question about uncertain futures. Also trigger when the user faces a fork-in-the-road decision, wants to stress-test an idea, or needs to think through consequences before committing.
vercel-react-best-practices
React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.
venue-templates
Access comprehensive LaTeX templates, formatting requirements, and submission guidelines for major scientific publication venues (Nature, Science, PLOS, IEEE, ACM), academic conferences (NeurIPS, ICML, CVPR, CHI), research posters, and grant proposals (NSF, NIH, DOE, DARPA). This skill should be used when preparing manuscripts for journal submission, conference papers, research posters, or grant proposals and need venue-specific formatting requirements and templates.