alessonviana GitHub avatar

software-documentation-framework

alessonviana

一个以证据驱动的软件文档框架,提供可移植的 Agent Skill、模板、安全证据收集器和自动校验,用于创建、审计和维护与代码及规格一致的文档。

Stars

3

7 天增长

暂无数据

Fork 数

0

开放 Issue

0

开源协议

暂无数据

最近更新

2026-07-30

AI 仓库情报摘要
FR-AI / ANALYSIS

为什么值得关注

它把文档工作变成证据驱动流程,兼容多种 AI 编码代理,并内置公开仓库安全规则和自动化验证,适合在 AI 辅助开发中保持文档可信。

适合谁使用

  • 需要编写项目文档的开发者和技术文档工程师
  • 使用 Codex、Claude Code、Gemini CLI、GitHub Copilot 等 AI 代理的团队
  • 需要审计或对齐文档、代码和规格的维护者
  • 希望用模板和 CI 校验改进文档流程的开源项目贡献者

典型使用场景

  • 审计现有仓库的文档是否与代码证据一致
  • 从零为绿地项目创建最小充分的文档集
  • 做定向文档更新,并区分事实、推断、冲突和未知项
  • 通过 GitHub Actions 在每次提交和 PR 中自动验证文档

项目优势

  • 遵循开放 Agent Skills 规范,可在多个代理主机之间移植使用
  • 安全证据收集器不会读取真实密钥、凭据或生成目录
  • 提供模板、方法论、公开仓库安全规则、测试和 CI 验证
  • 框架无关,可配合 Spec Kit、OpenSpec、BDD、RFC 等规格体系

使用前须知

  • 尚未选择开源许可证,当前不允许复制、修改或再分发
  • 需要按不同代理主机安装,调用方式也各不相同
  • 源代码只能作为当前行为的证据,不能自动证明产品意图;冲突时需要人工判断

README 快速开始

Quick start

项目描述

Evidence-driven framework for creating, validating, and maintaining software project documentation alongside code and specifications.

相关仓库与替代方案

根据分类、Topic 和编程语言匹配的相似项目。

yetone
精选
yetone GitHub avatar

kill-ai-slop

Kill AI Slop is a multilingual field guide and agent skill that catalogues 33 common AI-generated design tells with interactive before-after demos, and provides a tool to scan and fix web projects.

AI 与机器学习AI 智能体
805
gnipbao
精选
gnipbao GitHub avatar

story-to-handdrawn-video

A Remotion-based tool that converts Chinese story text or ordered hand-drawn images into vertical hand-drawn diary-comic animation with handwritten captions, left-to-right reveals, optional page-curl transitions, and silent H.264 output for post-production dubbing.

AI 与机器学习AI 智能体
683
lopopolo
精选
lopopolo GitHub avatar

harness-engineering

Harness Engineering is a methodology for improving coding agent outputs by carefully crafting the environment around them—providing curated context, tools, and executable constraints that encode an organization’s nonfunctional requirements and cumulative lessons.

AI 与机器学习AI 智能体
2,390