skilld
All skills
asyrafhussin avatar

/project-docs

@6cadc91
by Asyraf Hussinasyrafhussin/agent-skills81 stars
10

Project documentation lifecycle for PHP/Laravel and Node/TypeScript/React projects — bootstrapping essential docs, naming and folder conventions, freshness, and cleanup of AI-generated junk and stale files. Use when starting a new project, setting up docs/ structure, auditing markdown files, cleaning up the docs folder, or deciding which docs to keep, archive, or delete. Triggers on "set up docs", "audit docs", "clean up markdown", "what docs does this project need", "organize docs folder", "find stale docs".

Ask your Agent

Use this Skill: https://skilld.dev/gh/asyrafhussin/agent-skills/project-docs

This session only. Nothing lands on disk.

README.md

≈525 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Project Documentation

End-to-end documentation lifecycle for PHP/Laravel and Node/TypeScript/React projects. Covers folder structure, naming conventions, essential files, freshness, and cleanup of AI-generated junk. Supports bootstrap, audit, and reference modes.

Version: 1.0.0

Overview

  • Bootstrap a new project's docs (what's needed + scaffolded templates)
  • Audit existing markdown files: keep / update / archive / delete / move
  • Detect AI-generated plan/summary junk (PLAN.md, IMPLEMENTATION-SUMMARY.md, etc.)
  • Enforce folder structure (docs/architecture/, docs/adr/, docs/guides/, docs/runbooks/, docs/archive/)
  • Enforce naming (UPPERCASE.md for root files, kebab-case.md for docs, numbered ADRs)
  • 25 rules across 6 categories

Categories

1. Structure (CRITICAL)

Where docs live: root vs docs/; recommended sub-folder layout.

2. Naming (CRITICAL)

UPPERCASE.md for root, kebab-case.md for docs/*, numbered ADRs, no dates / no draft markers.

3. Essential Files (HIGH)

The minimum every project needs: README, CHANGELOG, LICENSE — plus CONTRIBUTING and SECURITY for projects that warrant them.

4. Quality (HIGH)

Conciseness over bloat, AI-slop fingerprints in prose, heading hierarchy, copy-pasteable code blocks, descriptive non-broken links.

5. Cleanup (HIGH)

Detect AI junk files, duplicates, orphans, and empty stubs; surface for triage without auto-deleting.

6. Lifecycle (MEDIUM)

Freshness dates, archive workflow, ADR process, CHANGELOG-on-PR discipline.

Usage

Set up docs for this Laravel project
Audit the markdown files in this repo
Clean up the docs folder
What docs does this project need?
Where should this architecture diagram go?
How should I name this ADR?
Find stale documentation

References

Source: SKILL.md on GitHub

Third-party checks

No alerts16d3 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    The skill is a comprehensive documentation lifecycle management tool for PHP/Laravel and Node.js projects. It provides a set of 25 rules for organizing, naming, and maintaining project documentation. The analysis found no security issues; the skill utilizes standard auditing practices and suggests well-known industry tools for documentation linting and quality assurance.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

Provenance

Signed by skilld at 6cadc91. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last month.

Steadyupdated 5 months ago

Capability

metadata
{
  "author": "agent-skills",
  "version": "1.0.0"
}

README badge

README badge for asyrafhussin/agent-skills/project-docs