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

feat: add pattern refine_design_document #1077

Merged
merged 1 commit into from
Oct 27, 2024

Conversation

xvnpw
Copy link
Contributor

@xvnpw xvnpw commented Oct 24, 2024

What this Pull Request (PR) does

refine_design_document pattern is used to refine particular design document according to review. It suppose to be used with two other pattern create_design_document (#1070) and review_design (#1072)

Example of usage:
PROJECT.md:

# AI Nutrition-Pro

## Business background

Dietitians use online applications to create meals, diets and calculate calories called meal planners. Different professionals have different ways of creating diets, which gives a personal style to it. LLMs can reproduce this personal style of writing based on samples of already created content. Meal planners can use LLMs to speed up diet creation for dietitians.

## Project Overview

AI Nutrition-Pro will be backend API application that will have the possibility to integrate with any meal planner application for dietitians. It will reproduce the personal style of a nutrition specialist based on samples.

Dietitians will not use the application directly but from their meal planner applications. There will be no user interface exposed to Dietitians. Integration will be using meal plan applications backend.

Direct clients of AI Nutrition-Pro will be applications like DietMaster Pro, Nutritionist Pro, or others. Those clients will send to AI Nutrition-Pro samples of content and AI Nutrition-Pro will generate requested type of content based on that. AI Nutrition-Pro will use LLM to generate requested content.

## Core Features

- multi-tenant API application - where tenant is client application like DietMaster Pro, Nutritionist Pro, or others.
- each tenant can contain many dietitians.
- each dietitian can have multiple customers.
- the application will be deployed into AWS cloud and use cloud-based services to store and process data.
- the application will store and process PII information that might contain personal health data of customers.
- ChatGPT 3.5 will be used as LLM.

## High level connection view

mermaid
flowchart TB
    DietMaster-Pro --> AI-Nutrition-Pro
    Nutritionist-Pro --> AI-Nutrition-Pro
    subgraph AWS
    AI-Nutrition-Pro
    end
    subgraph OpenAI
    ChatGPT-3.5
    end
    AI-Nutrition-Pro --> ChatGPT-3.5

Create design document:

echo "DESIGN DOCUMENT" > design-document.md
cat PROJECT.md | fabric -p create_design_document >> design-document.md

Manually review design document

Create review pattern:

echo "DESIGN REVIEW" > design-review.md
cat design-document.md | fabric -p review_design >> design-review.md

Refine design according to review with pattern:

cat design-document.md design-review.md | fabric -p refine_design_document >> design-document-refined.md

Related issues

Screenshots

@eugeis eugeis merged commit b4e439e into danielmiessler:main Oct 27, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants