Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DocOps Agent —— AI 项目文档智能运维与生命周期管理 Agent

Version

DocOps Agent is an AI engineering governance for protecting project knowledge, staging documentation changes, managing assets, enforcing policy, and maintaining audit trails.

DocOps Agent 是一个 AI 工程治理,用于保护项目知识资产、暂存文档变更、管理资产生命周期、执行策略检查并维护审计轨迹。

Core Value / 核心价值

  • Non-destructive project adoption / 非破坏性接管已有项目
  • Human-owned asset protection / 保护人类创建的项目资产
  • Review-gated documentation publishing / 文档发布必须经过 Review
  • Policy-controlled cleanup / 清理操作受 Policy 控制
  • Append-only governance audit / 追加式治理审计

Quick Start / 快速开始

  1. Copy docops-agent/ into the Codex skill collection.
  2. Enter a target project through DocOpsOrchestrator.bootstrap().
  3. Greenfield projects enter active; Brownfield projects are scanned, reported, and placed in safe_mode.
  4. Use the documented commands through the Orchestrator.
from core.orchestrator import DocOpsOrchestrator

runtime = DocOpsOrchestrator("/path/to/project")
runtime.bootstrap()
runtime.sync_docs(["API interface changed"])

首次接入时,Runtime 会创建或使用 .docops/ 元数据目录。Brownfield 项目不会自动修改已有文件。

中文用户文档:

Installation / 安装方式

Copy the docops-agent/ directory into the local skill collection. A target project uses:

docs/
.review/
.tmp_outputs/
.docops/
src/

Existing project directories are not restructured automatically. Review docs/lifecycle.md before onboarding a project.

Supported Commands / 支持命令

  • /sync-docs: analyze meaningful changes and stage documentation candidates.
  • /review-docs: inspect and approve staged candidates.
  • /finalize-docs: preview, confirm, archive, or delete approved temporary outputs.
  • /audit-docs: generate a project documentation governance report.

Command details: docs/commands.md

Architecture / 架构概览

Command
  -> DocOpsOrchestrator
  -> Bootstrap / Review / Cleanup / Manifest / Policy / Impact
  -> Audit Logger

Architecture details: docs/architecture.md

Security / 安全机制

The runtime classifies before mutation, stages generated documents in .review/, refuses immutable or existing destinations, requires explicit confirmation for destructive actions, and records structural mutations in .docops/audit.log.

Runtime 会先分类再修改,将生成内容暂存到 .review/,拒绝覆盖 immutable 或已存在目标,破坏性操作必须显式确认,并将结构变化写入 .docops/audit.log

Security details: docs/security-model.md

Current Version / 当前版本

DocOps Agent v2.2.0 Frozen Core Release

Core implementation frozen. Current tests: 27 passing.

See docs/versions.md and docs/api-contract.md.

Future Roadmap / 未来路线

v3.0 is planned only. It is not implemented in the v2.2 frozen runtime.

路线详情:docs/roadmap.md

Package Map

  • SKILL.md: runtime identity and mandatory governance rules.
  • commands/: Agent-facing command procedures.
  • core/: frozen runtime implementation.
  • schemas/: state, manifest, and policy contracts.
  • templates/: document and policy templates.
  • tests/: unit, integration, and freeze regression tests.
  • docs/: project documentation package.

Releases

Packages

Contributors

Languages