agentleFS
Sign inStart free
marlonvidalmarlonvidal/tech-manager-os/.agents/skills/bmad-index-docs/SKILL.md

bmad-index-docs

Skill17 starsChanged 4 months agoMITView on GitHub

Generates or updates an index.md to reference all docs in the folder. Use if user requests to create or update an index of all files in a specific folder

We split this skill into the rules it gives an agent

5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename

    line 23
  2. Distinctive:

    Write or update index.md with organized file listings

    line 27
  3. Very specific:

    Use relative paths starting with ./

    line 61
  4. Distinctive:

    Read file contents to generate accurate descriptions - don't guess from filenames

    line 63
  5. Distinctive:

    Keep descriptions concise but informative (3-10 words)

    line 64

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Index Docs

Goal: Generate or update an index.md to reference all docs in a target folder.

EXECUTION

Step 1: Scan Directory

  • List all files and subdirectories in the target location

Step 2: Group Content

  • Organize files by type, purpose, or subdirectory

Step 3: Generate Descriptions

  • Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename

Step 4: Create/Update Index

  • Write or update index.md with organized file listings

OUTPUT FORMAT

# Directory Index

## Files

- **[filename.ext](./filename.ext)** - Brief description
- **[another-file.ext](./another-file.ext)** - Brief description

## Subdirectories

### subfolder/

- **[file1.ext](./subfolder/file1.ext)** - Brief description
- **[file2.ext](./subfolder/file2.ext)** - Brief description

### another-folder/

- **[file3.ext](./another-folder/file3.ext)** - Brief description

HALT CONDITIONS

  • HALT if target directory does not exist or is inaccessible
  • HALT if user does not have write permissions to create index.md

VALIDATION

  • Use relative paths starting with ./
  • Group similar files together
  • Read file contents to generate accurate descriptions - don't guess from filenames
  • Keep descriptions concise but informative (3-10 words)
  • Sort alphabetically within groups
  • Skip hidden files (starting with .) unless specified

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free