Back to Prompts
Coding Assistant

Add AI-Friendly Module Documentation

For making modules AI-readable From the Modular Architecture AI Coding Building Block.

Prompt
Add documentation to my module that helps AI coding assistants understand it quickly.

Module path: [folder/file path]

Create:
1. A MODULE_README.md with:
   - One-paragraph purpose statement
   - Public interface summary (what other modules should call)
   - Example usage snippets
   - What this module does NOT handle (boundaries)

2. Inline documentation:
   - Docstrings for all public functions
   - Type hints for all parameters and returns
   - Brief comments for non-obvious logic

3. An ARCHITECTURE.md if the module has multiple files explaining:
   - How files relate to each other
   - Data flow through the module
   - Key design decisions

Goal: An AI assistant should be able to read these docs and immediately understand how to work with this module without reading every line of code.

I'm learning, so explain each part simply.
70 views 2 copies