skills.rest
SatoryKono
SatoryKonoCOMMUNITY
Explore all skills by this author →
GitHub

documentation-audit

Audit BioETL documentation against code and ADRs for v5.22+ gaps.

1|Updated Dec 1, 2025
Search Tags:#documentation#audit#mkdocs#bioetl#adr-010#adr-014#adr-017
One-click install
npx skills add https://github.com/SatoryKono/BioactivityDataAcquisition --skill documentation-audit-satorykono
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-audit
Source: https://github.com/SatoryKono/BioactivityDataAcquisition/tree/main/docs/skills/local/documentation-audit
Command: npx skills add https://github.com/SatoryKono/BioactivityDataAcquisition --skill documentation-audit-satorykono

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Identify documentation gaps and align BioETL docs with the codebase and ADRs, focusing on v5.22+.

Core Features & Use Cases

  • Aligns documentation with code changes and ADR updates (ADR-010, ADR-014, ADR-017).
  • Produces an audit report, prioritized plan, and synchronized documentation updates.
  • Supports references to audit-checklist.md and report-template.md for consistent audits.

Quick Start

Run this skill to audit BioETL documentation against code and ADRs (v5.22+), producing an audit report, prioritized plan, and updated docs.

Frequently Asked Questions about documentation-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit documentation against code and ADRs?▼

To audit documentation against code and ADRs, you can use this Skill to identify gaps and align BioETL docs with the codebase and architecture decisions, producing an audit report and prioritized plan.

What is the best way to align MkDocs with BioETL v5.22+ updates?▼

Aligning MkDocs with BioETL v5.22+ updates is done by verifying ADR alignment for ADR-010, ADR-014, and ADR-017, ensuring links and navigation remain consistent across core docs and contract sections.

How do I enforce an audit checklist when reviewing technical docs?▼

You can enforce an audit checklist when reviewing technical docs by referencing audit-checklist.md and report-template.md, which this Skill requires to produce a structured audit report and documented changes.

Can I generate a prioritized plan for fixing documentation gaps?▼

Yes, you can generate a prioritized plan for fixing documentation gaps by running this Skill across core docs, architecture, providers, and contract sections to output a structured remediation plan.

Does the documentation audit verify ADR-010, ADR-014, and ADR-017 compliance?▼

Yes, the documentation audit verifies ADR-010, ADR-014, and ADR-017 compliance by operating across architecture sections to align documentation with code changes and ADR updates for BioETL v5.22+.

Related Skills

Explore More Content & Communication Skills→
rodoHasArrivedrodoHasArrived

meridian-provider-builder

Scaffold Meridian data provider adapters with ADR-compliant test scaffolds.

Community
Advanced
PelekePeleke

llms-txt-generator

Generate llms.txt and llms-full.txt files from MkDocs navigation and markdown content.

Community
Intermediate
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced
noelserdnanoelserdna

traceability-check

Validate SDD artifact traceability and report orphaned or broken references.

Community
Basic