Skip to content

Instantly share code, notes, and snippets.

@ajcwebdev
Last active October 24, 2025 02:24
Show Gist options
  • Select an option

  • Save ajcwebdev/05317042e3f11d0897a7140f47c3a689 to your computer and use it in GitHub Desktop.

Select an option

Save ajcwebdev/05317042e3f11d0897a7140f47c3a689 to your computer and use it in GitHub Desktop.
Demo

Prompt 1: Project Overview Documentation

Let's start by creating comprehensive project documentation. I'll ask Claude to analyze our codebase and create a README.

Look at this codebase and create a comprehensive README.md that includes:
- Project overview and prerequisites
- Installation instructions
- Running the project
- Project structure
- API endpoints
- Database schema

Prompt 2: API Documentation

Now let's create detailed API documentation so other developers know exactly how to interact with our backend.

Create an API_DOCS.md file that documents all the API endpoints in server/index.ts. For each endpoint include:
- HTTP method
- URL path
- Request body format (with example)
- Response format (with example)
- Status codes
- Example curl commands

Prompt 3: Code Documentation

Finally, let's add inline documentation to make the code more maintainable.

Add JSDoc comments to all functions in server/db.ts and server/index.ts. Include:
- Function description
- Parameter descriptions with types
- Return value description
- Example usage where helpful
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment