5 个仓库
Analysis of code changes to determine if new public surfaces are adequately documented.
Distinct from Code Coverage: Analyzes documentation gaps based on code changes, distinct from measuring test suite code coverage
Explore 5 awesome GitHub repositories matching part of an awesome list · Documentation Coverage Analysis. Refine with filters or upvote what's useful.
gstack is an AI agent framework and development workflow system designed to automate the software development lifecycle. It coordinates specialized AI personas to manage tasks across product design, engineering management, and quality assurance, transforming product intent into technical specifications and final releases. The project is distinguished by its deep integration of headless browser automation and semantic code memory. It utilizes a persistent Chromium daemon for web scraping and visual auditing, and implements a searchable knowledge base that logs architectural decisions and repos
Identifies undocumented public surfaces by analyzing code diffs against required documentation types.
TypeDoc is a documentation generator and AST analyzer that transforms TypeScript source code and comments into structured API reference websites or data files. It functions as a static site generator that converts code symbols into a searchable web interface. The project is an extensible framework, allowing users to modify the documentation process and generator logic through a programmable plugin system and custom themes. Its capabilities include API reference generation, source code parsing, and documentation coverage validation to ensure exported members are properly described. It support
Validates that all exported symbols have descriptions and treats missing documentation as build errors.
Jazzy is a source code documentation tool and API generator designed for Swift and Objective-C. It analyzes project roots and compiled modules to produce searchable HTML websites or offline docsets. The system functions as a multi-module API documenter, aggregating documentation from separate source modules into a single site with cross-module linking. It serves as a markdown-based documentation engine that integrates technical guides and LaTeX mathematical equations to complement generated API references. The tool covers a broad capability surface including multi-language API generation for
Tracks the percentage of documented symbols to analyze documentation gaps and generate coverage badges.
tbls 是一个基于 Go 的命令行工具,用于记录、分析和检查关系数据库模式。它是一个文档生成工具,可以生成 Markdown、JSON 或 Excel 格式的结构化报告和实体关系图,同时也是一个模式差异对比工具,用于识别实时数据库与文档之间的差异。 该项目允许通过外部配置文件进行模式增强和定义虚拟关系,从而在无需数据库迁移或原生约束的情况下实现元数据覆盖和表连接。它还支持将表组织成基于域的视图,以创建对整体模式的精选视角。 其他功能包括通过 SQL linter 根据预定义规则验证数据库结构,以及测量文档覆盖率以确定已描述表和列的百分比。该系统利用基于 JSON 的驱动程序接口集成外部可执行文件以支持各种数据库类型,并使用可自定义的模板进行文档生成。
Calculates the percentage of tables and columns that possess descriptions to measure documentation coverage.
Compodoc 是一个 TypeScript API 文档生成器、静态站点生成器和项目架构可视化工具。它解析源代码和 JSDoc 注释,以创建可搜索的技术参考站点、API 目录和独立 HTML 页面。 该项目通过分析 import 语句来生成依赖图和模块映射,从而展示代码库内的结构关系,这使其脱颖而出。它包括对可视化 Angular 项目、NestJS 工作流和 Stencil Web 组件的专门支持,并可将实时工作演示直接嵌入到文档页面中。 该系统还充当文档覆盖率分析器,提供报告并在持续集成流水线中强制执行最低覆盖率阈值,如果文档水平不足则导致构建失败。其他功能包括 Markdown 集成、多格式数据导出(JSON 或 Markdown),以及带有文件系统监控以实现自动重建的本地开发服务器。 用户可以通过配置文件、自定义 CSS 样式和元素可见性过滤来自定义输出,以从最终站点中排除特定符号或内部标签。
Calculates the percentage of documented code and provides reports on documentation gaps.