AiPromptss
Back to browse

Basic Documentation Structure

Help me create comprehensive documentation for a user authentication module: Module features: - Email/password authentication - Social login integration (Googl…

Added May 19, 20260 views0 copies
Prompt
Help me create comprehensive documentation for a user authentication module:

Module features:
- Email/password authentication
- Social login integration (Google, Facebook, GitHub)
- Password reset functionality
- Session management with JWT
- Role-based access control

Target audience: Mid-level developers integrating the module
Documentation format: Markdown with code examples

Required sections:
1.
Overview and architecture
2.
Installation and dependencies
3.
Configuration options
4.
API Reference with request/response examples
5.
Integration examples in JavaScript/TypeScript
6.
Security considerations
7.
Troubleshooting common issues

Please include:
- A clear introduction explaining the module's purpose
- Code snippets for each major feature
- Configuration examples with explanations
- Best practices for implementation
- Common pitfalls to avoid

Replace text in [BRACKETS] with your own values before pasting.