Skip to main content

Custom Documents Guide

Table of Contents​

  1. Introduction
  2. When to Use Custom Documents
  3. Creating Custom Documents
  4. Document Types and Examples
  5. Best Practices
  6. Managing Custom Documents
  7. Common Use Cases
  8. FAQ

Introduction​

While ProjectDocsEngine automatically generates 6 core documents for your project, you often need additional specialized documentation. Custom Documents allow you to extend your project documentation with any type of document you need, all while maintaining consistency with your existing docs.

Key Benefits​

  • Flexibility: Create any type of document your project needs
  • AI-Powered: Documents are generated using the same AI that powers core docs
  • Consistency: Automatically maintains consistency with existing documentation
  • Integration: Custom docs are fully integrated into your project's documentation set

When to Use Custom Documents​

Perfect For:​

  • API Documentation: Detailed endpoint specifications
  • Security Policies: GDPR compliance, data handling procedures
  • Testing Strategies: QA processes, test plans
  • Deployment Guides: Infrastructure setup, CI/CD pipelines
  • Business Documents: Marketing plans, business models
  • Team Resources: Onboarding guides, coding standards
  • Architecture Details: System design, microservices documentation
  • Replacing core documents (use Command Mode to update those)
  • Quick notes or temporary documentation
  • External documentation not related to your project

Creating Custom Documents​

Step-by-Step Process​

1. Access Custom Documents​

Navigate to your project workspace and click the "Add Custom Document" button in the sidebar.

2. Define Document Details​

Document Name

Examples:
- "API Endpoint Reference"
- "Security and Compliance Guide"
- "Mobile App Architecture"
- "DevOps Playbook"

Purpose/Description Be specific about what the document should contain:

❌ Vague: "API documentation" ✅ Specific: "RESTful API documentation with authentication details, rate limiting, error codes, and example requests/responses for all endpoints"

3. Provide Context​

The AI uses your existing documentation as context. You can specify:

  • Which existing docs are most relevant
  • Any specific sections to reference
  • External requirements to consider

Example Context:

"This API documentation should align with the authentication system described in the Technical Stack document and follow the RESTful patterns mentioned in the Development Task List. Include rate limiting details from the PRD's scalability section."

Generation Process​

  1. AI Analysis: The AI analyzes your request and existing documentation
  2. Content Generation: Creates comprehensive content based on your requirements
  3. Consistency Check: Ensures alignment with existing docs
  4. Integration: Adds the document to your project

Generation typically takes 1-3 minutes depending on complexity and detail level.

Credit Cost​

Custom documents cost credits based on your project's detail level:

  • Basic: 2 credits per document
  • Standard: 4 credits per document
  • Enterprise: 7 credits per document

Document Types and Examples​

1. API Documentation​

Good Request:

Document Name: REST API Reference

Purpose: Complete API documentation including:
- Authentication (JWT tokens, API keys)
- All endpoints with request/response examples
- Error codes and handling
- Rate limiting (100 req/min per user)
- Webhook specifications
- SDK usage examples

Generated Structure:

  • Overview and Base URL
  • Authentication Methods
  • Endpoints by Resource
  • Request/Response Formats
  • Error Handling
  • Rate Limiting
  • Webhooks
  • Code Examples

2. Security & Compliance​

Good Request:

Document Name: Security and GDPR Compliance Guide

Purpose: Comprehensive security documentation covering:
- Data encryption (at rest and in transit)
- GDPR compliance measures
- User data handling and retention
- Access control and authentication
- Security audit procedures
- Incident response plan

3. Testing Strategy​

Good Request:

Document Name: Comprehensive Testing Strategy

Purpose: Testing documentation including:
- Unit testing approach and coverage goals (80%+)
- Integration testing scenarios
- E2E testing with Playwright
- Performance testing benchmarks
- Security testing procedures
- Test data management

4. Deployment Guide​

Good Request:

Document Name: Production Deployment Guide

Purpose: Step-by-step deployment documentation:
- AWS infrastructure setup (ECS, RDS, S3)
- Environment configuration
- CI/CD pipeline with GitHub Actions
- Monitoring and logging setup
- Rollback procedures
- Scaling strategies

5. Business Documentation​

Good Request:

Document Name: Go-to-Market Strategy

Purpose: Business strategy documentation:
- Target market analysis
- Pricing strategy and tiers
- Marketing channels and campaigns
- Competitor analysis
- Success metrics and KPIs
- Launch timeline

Best Practices​

1. Be Specific and Detailed​

❌ Poor Request:

"Add documentation for mobile app"

✅ Good Request:

"Create React Native mobile app documentation including:
- Project setup and dependencies
- Navigation structure using React Navigation
- State management with Redux
- API integration patterns
- Push notification setup
- Offline functionality
- Build and deployment process for iOS/Android"

2. Reference Existing Documentation​

Always mention which existing docs should be considered:

"This mobile app documentation should reference the API endpoints from the Technical Stack document and follow the design guidelines from the UI/UX document."

3. Include Technical Specifications​

Provide specific technical details:

"Document the GraphQL API with:
- Schema definitions using SDL
- Query and mutation examples
- Subscription implementation with WebSockets
- Authentication using Apollo Client
- Error handling patterns
- Performance optimization with DataLoader"

4. Specify the Audience​

Clarify who will use the document:

"This deployment guide is for DevOps engineers familiar with AWS but new to our specific architecture"

5. Set Clear Boundaries​

Define what should and shouldn't be included:

"Focus on production deployment only. Don't include local development setup (that's in the README). Include only AWS deployment, not other cloud providers."

Managing Custom Documents​

Updating Custom Documents​

Use Command Mode to update custom documents:

"Update the API documentation to include the new payment endpoints with Stripe webhook handling"

Organizing Custom Documents​

  • Custom documents appear alongside core documents
  • They're included in exports
  • They maintain version history
  • They can be referenced in Command Mode updates

Deleting Custom Documents​

Currently, documents cannot be deleted through the UI. If you need to remove a document, you can:

  1. Update it to a minimal state using Command Mode
  2. Exclude it from exports
  3. Contact support for permanent removal

Common Use Cases​

1. Microservices Architecture​

Create separate documents for each service:

  • "User Service API Documentation"
  • "Payment Service Architecture"
  • "Notification Service Guide"

2. Multi-Platform Projects​

Document each platform separately:

  • "iOS App Development Guide"
  • "Android App Development Guide"
  • "Web Application Architecture"

3. Compliance-Heavy Projects​

Create specialized compliance docs:

  • "HIPAA Compliance Procedures"
  • "SOC 2 Audit Preparation"
  • "PCI DSS Implementation"

4. Open Source Projects​

Add community-focused documentation:

  • "Contributing Guidelines"
  • "Code of Conduct"
  • "Plugin Development Guide"

Tips for Quality Custom Documents​

1. Provide Examples​

"Include curl examples for each endpoint, showing both successful and error responses"

2. Specify Formatting​

"Use tables for API parameters, code blocks for examples, and diagrams for architecture"

3. Include Edge Cases​

"Document error handling for network failures, invalid inputs, and rate limit exceeded scenarios"

4. Request Specific Sections​

"Include these sections: Overview, Prerequisites, Step-by-Step Guide, Troubleshooting, FAQ"

FAQ​

Q: How many custom documents can I create?​

A: You can create up to 9 custom documents per project. This includes specialized documentation like API specs, testing guides, deployment instructions, and more.

Q: Can I create custom documents in languages other than English?​

A: Currently, custom documents are generated in English only. Multilingual support is planned for future releases.

Q: How long are custom documents?​

A: Custom documents follow the same word count guidelines as your detail level:

  • Basic: 1,000-1,800 words
  • Standard: 1,500-3,000 words
  • Enterprise: 2,700-4,200 words

Q: Can I import existing documentation?​

A: Not directly, but you can:

  1. Create a custom document with the same title
  2. Use Command Mode to update it with your existing content
  3. The AI will integrate it with your project's style

Q: Do custom documents affect my credit usage?​

A: Yes, custom documents consume credits based on your detail level:

  • Basic: 2 credits per document
  • Standard: 4 credits per document
  • Enterprise: 7 credits per document

Q: Can custom documents reference each other?​

A: Yes! When creating or updating documents, you can reference any existing document, including other custom documents.

Q: What if the generated document isn't what I expected?​

A: Use Command Mode to refine it. For example:

"The API documentation is missing webhook examples. Add detailed webhook implementation with signature verification and retry logic"

Summary​

Custom Documents are a powerful way to extend your project documentation beyond the core 6 documents. By being specific in your requests, providing context, and following best practices, you can create comprehensive documentation that perfectly fits your project's unique needs.

Remember:

  • Be specific and detailed in your requests
  • Reference existing documentation for consistency
  • Use Command Mode to refine and update
  • Think about your audience and use cases
  • Provide examples and technical specifications

With Custom Documents, your project documentation can be as comprehensive and specialized as your project requires.