Use App Requirements Doc

Learn how to use your App Requirements Document.

Purpose

You can use the app requirements document to store context for that Deplyr AI should be aware of between edits.

Usage Tips

  • Add in the purpose of your app.

  • Write down the colors you want to use throughout your app.

  • Write the integrations used in your app.

  • If you have complex interactions like autosaving or debounced fuzzy searching, add that into your requirements doc.

Example

Here's an Example requirements doc.

Product Requirements Document: Inventory Management App

Goal
*   Provide a user-friendly interface for managing inventory items.
*   Enable users to quickly add new items with relevant details.
*   Offer a visually appealing and modern design.

Core Product Requirements and Features

*   Add Inventory Item Form:
    *   Fields:
        *   Product Name (text input, required)
        *   Listed Price (number input, required, step 0.01)
        *   Sale Price (number input, step 0.01)
        *   Description (textarea, readonly, background grayed out)
        *   Sold (select input)
    *   Functionality:
        *   Form submission to add a new item to the inventory.
*   Modern UI Styling:
    *   Gradient background.
    *   Rounded corners on elements (form, inputs, buttons).
    *   Improved spacing between form elements.
    *   Refined typography.
    *   Enhanced button styling with gradient and hover effects.

Last updated