alessonviana GitHub avatar

software-documentation-framework

alessonviana

An evidence-driven framework for creating, auditing, and maintaining software documentation using a portable Agent Skill, templates, safe evidence collection, and automated validation.

Stars

3

7-day growth

No data

Forks

0

Open issues

0

License

No data

Last updated

2026-07-30

AI repository intelligence
FR-AI / ANALYSIS

Why it is worth attention

It reframes documentation as an evidence-driven process and provides a portable Agent Skill that works across multiple AI coding agents, with public-repository safeguards and CI validation.

Who it is for

  • Developers and technical writers creating project documentation
  • Teams using AI coding agents like Codex, Claude Code, Gemini CLI, and GitHub Copilot
  • Maintainers who need to audit or align documentation with code and specifications
  • Open-source contributors looking for documentation templates and validation workflows

Use cases

  • Auditing an existing repository's documentation against actual project evidence
  • Creating documentation from scratch for a greenfield project
  • Performing focused documentation updates while flagging conflicts and unknowns
  • Automating documentation validation in CI with GitHub Actions

Strengths

  • Portable skill follows the open Agent Skills specification and supports multiple agent hosts
  • Safe evidence collector avoids reading real secrets, credentials, and generated directories
  • Includes templates, methodology, public-repository safety rules, tests, and automated validation
  • Framework-agnostic support for Spec Kit, OpenSpec, BDD, RFCs, and other specification systems

Considerations

  • No open-source license has been selected yet, so copying, modification, and redistribution are not currently permitted
  • Installation and invocation vary by agent host, requiring per-tool setup
  • Source code is evidence of current behavior, not proof of intended product behavior; conflicts require human decisions

README quick start

Quick start

Description

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

Related repositories

Similar projects matched by category, topics, and programming language.

yetone
Featured
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 & Machine LearningAI Agents
805
gnipbao
Featured
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 & Machine LearningAI Agents
683
lopopolo
Featured
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 & Machine LearningAI Agents
2,390