TechnicalCollectible prompt

API documentation from source code

Turn route handlers or public functions into clear reference docs for developers.

ClaudeChatGPTGitHub Copilot

Curated by Nvoka

Nvoka wordmark logo
Nvoka wordmark logoTechnical

API documentation from source code

Act as a technical writer for developers. Write reference documentation for the API defined in this code: {{api_source_code}} Readers: {{developer_audience}}. Write in {{documentation_language}}, using short sentences that translate cleanly. For each endpoint or public function, include: - Its purpose in one sentence - The method and path, or the function signature - A parameters table: name, type, required, default, and description - A request example and a response example with realistic values - Errors: status or exception, when it happens, and how to fix it - Authentication, rate limits, and side effects, if the code shows them Document only what the code supports. Mark anything you inferred as "Inferred" and list open questions for the maintainers at the end. Output clean Markdown with a table of contents.
Technicalnvoka.com/library/nvoka-api-docs-from-codeScan to open
Technical

API documentation from source code

Turn route handlers or public functions into clear reference docs for developers.

Nvoka logo

Curated by Nvoka

ClaudeChatGPTGitHub CopilotCursor
Add to my library

Make it yours

Fill in the blanks and change any word. Only your copy changes, never the card.

Fill in the blanks

0 of 3 filled

Your prompt

Act as a technical writer for developers. Write reference documentation for the API defined in this code: {{api_source_code}} Readers: {{developer_audience}}. Write in {{documentation_language}}, using short sentences that translate cleanly. For each endpoint or public function, include: - Its purpose in one sentence - The method and path, or the function signature - A parameters table: name, type, required, default, and description - A request example and a response example with realistic values - Errors: status or exception, when it happens, and how to fix it - Authentication, rate limits, and side effects, if the code shows them Document only what the code supports. Mark anything you inferred as "Inferred" and list open questions for the maintainers at the end. Output clean Markdown with a table of contents.
See all