Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: sorts of chores #763

Merged
merged 1 commit into from
May 8, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 9 additions & 24 deletions .github/ISSUE_TEMPLATE/prd.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Product Requirement Documentation
about: Submit an detail PRD for APITable
name: Product(Feature) Requirement Documentation
about: Submit an detail feature PRD for APITable
title: 'feat: PRD...'
labels: 'enhancement'
assignees: ''
Expand All @@ -13,18 +13,12 @@ assignees: ''

# 2. Business Analysis

> 2.1 Who are the users and stakeholders? What are the users' stories? What problems do they have?
>
> 2.1 Who are the features' users and stakeholders? What are the users' stories? What problems do they have?
> 2.2 What are the inner needs, intrinsic motivation and humanity desires of the users (or customers)? How can we help them?
>
> 2.3 What is the specific features, requirements, or solutions list?
>
> 2.4 What content would you write in your tweets, blog posts, or newsletters to ensure that this feature is effectively promoted to your target audience?
>
> 2.4 What content would you write in your tweets, APITable blog posts, or newsletters to ensure that this feature is effectively promoted to your target audience?
> 2.5 What are the similar features among competitors for this feature? How do they implement similar features?
>
> 2.6 Would you please create a flowchart depicting the user interface operation process or workflow?
>
> 2.7 Hey reader: any questions with the above questions and answers?

# 3. Product Engineering
Expand All @@ -33,6 +27,7 @@ assignees: ''

| Term | Definition |
|----|----|
| APITable | APITable.com is an open-source no-code / visual database that enables users to create project management and customer management systems with just a few clicks in the age of AI. |
| API | Application Programming Interface - a set of protocols, routines, and tools for building software applications |
| Agile | A software development methodology that emphasizes iterative and incremental development, adaptive planning, and continuous improvement |
| Back-end | The part of a software application or system that is responsible for processing data and logic, typically not visible to the end user |
Expand All @@ -45,18 +40,14 @@ assignees: ''
| Waterfall | A traditional software development methodology that emphasizes a linear, sequential approach to development, with distinct phases for design, development, testing, and release |

> 3.2 How is the functional structure diagram represented in the mind map format?
>
> 3.3 What do the product feature prototypes look like?
>
> 3.4 Hey reader: any questions with above questions and answers?
> 3.4 Hey reader: any questions with above questions and answers?


# 4. User Experience

> 4.1 What does the UX design draft look like?
>
> 4.2 Could you provide a video explanation of the UX/UI design draft?
>
> 4.3 What does the final high-fidelity UI design look like?


Expand All @@ -79,21 +70,15 @@ assignees: ''
# 6. Technical Architecture

> 6.1 What are the technical architecture plans for implementing this feature?
>
> 6.2 Can you provide a visual representation of the data structures and data flow using either swim lane, UML, or flowcharts?
>
> 6.2 Can you provide a visual representation of the data structures and data flow using either swimlane, UML, or flowcharts?
> 6.3 What changes will be made to the back-end code and database structure?
>
> 6.4 What changes will be made to the front-end code and design components?
>
> 6.5 Is there a requirement for data tracking and analysis?
>
> 6.6 Hey reader: any questions with above questions and answers?
> 6.6 Hey reader: any questions with above questions and answers?

# 7. Project Management

> 7.1 Can you breakdown the steps and milestones of the implementation plan for this feature?
>
> 7.2 Can you breakdown the issues and responsibilities for each team member involved in the product development process?

# 8. Appendix
Expand All @@ -102,6 +87,6 @@ assignees: ''

# 9. Next Steps

> After read this PRD, what next steps you want?
> After read this APITable's feature PRD, what next steps you want?


Loading