|
53 | 53 | - Color coding or shapes to distinguish between different types of components |
54 | 54 | - A legend explaining any symbols or abbreviations used |
55 | 55 |
|
56 | | -7. Emphasize the importance of keeping the diagram at an appropriate level of abstraction while still keeping a significant amount of detail and capturing the essential architectural elements. |
| 56 | +7. NOTE: Emphasize the importance of being very detailed and capturing the essential architectural elements. Don't overthink it too much, simply separating the project into as many components as possible is best. |
57 | 57 |
|
58 | 58 | Present your explanation and instructions within <explanation> tags, ensuring that you tailor your advice to the specific project based on the provided file tree and README content. |
59 | 59 | """ |
|
77 | 77 | 3. Include both directories and specific files when relevant. |
78 | 78 | 4. If a component doesn't have a clear corresponding file or directory, simply dont include it in the map. |
79 | 79 |
|
80 | | -Before providing your final answer, use the <scratchpad> to think through your process: |
81 | | -1. List the key components identified in the system design. |
82 | | -2. For each component, brainstorm potential corresponding directories or files. |
83 | | -3. Verify your mappings by double-checking the file tree. |
84 | | -
|
85 | | -<scratchpad> |
86 | | -[Your thought process here] |
87 | | -</scratchpad> |
88 | | -
|
89 | 80 | Now, provide your final answer in the following format: |
90 | 81 |
|
91 | 82 | <component_mapping> |
|
97 | 88 | Remember to be as specific as possible in your mappings, only use what is given to you from the file tree, and to strictly follow the components mentioned in the explanation. |
98 | 89 | """ |
99 | 90 |
|
| 91 | +# ❌ BELOW IS A REMOVED SECTION FROM THE ABOVE PROMPT USED FOR CLAUDE 3.5 SONNET |
| 92 | +# Before providing your final answer, use the <scratchpad> to think through your process: |
| 93 | +# 1. List the key components identified in the system design. |
| 94 | +# 2. For each component, brainstorm potential corresponding directories or files. |
| 95 | +# 3. Verify your mappings by double-checking the file tree. |
| 96 | + |
| 97 | +# <scratchpad> |
| 98 | +# [Your thought process here] |
| 99 | +# </scratchpad> |
| 100 | + |
100 | 101 | # just adding some clear separation between the prompts |
101 | 102 | # ************************************************************ |
102 | 103 | # ************************************************************ |
|
140 | 141 | - If you believe the component references a specific file, include the file path. |
141 | 142 | - Make sure to include the full path to the directory or file exactly as specified in the component mapping. |
142 | 143 | - It is very important that you do this for as many files as possible. The more the better. |
| 144 | +- IMPORTANT: these are for click events only, these paths should not be included in the diagram's node's names. |
143 | 145 |
|
144 | 146 | Your output should be valid Mermaid.js code that can be rendered into a diagram. |
145 | 147 |
|
|
152 | 154 |
|
153 | 155 | EXTREMELY Important notes on syntax!!! (PAY ATTENTION TO THIS): |
154 | 156 | - Make sure to add colour to the diagram!!! This is extremely critical. |
155 | | -- In Mermaid.js syntax, we cannot include special characters for nodes without being inside quotes! For example: `EX[/api/process (Backend)]:::api` is a syntax error but `EX["/api/process (Backend)"]:::api` is valid. This is extremely important. |
| 157 | +- In Mermaid.js syntax, we cannot include special characters for nodes without being inside quotes! For example: `EX[/api/process (Backend)]:::api` and `API -->|calls Process()| Backend` are two examples of syntax errors. They should be `EX["/api/process (Backend)"]:::api` and `API -->|"calls Process()"| Backend` respectively. Notice the quotes. This is extremely important. Make sure to include quotes for any string that contains special characters. |
156 | 158 | - In Mermaid.js syntax, you cannot apply a class style directly within a subgraph declaration. For example: `subgraph "Frontend Layer":::frontend` is a syntax error. However, you can apply them to nodes within the subgraph. For example: `Example["Example Node"]:::frontend` is valid, and `class Example1,Example2 frontend` is valid. |
157 | 159 | """ |
158 | 160 | # ^^^ note: ive generated a few diagrams now and claude still writes incorrect mermaid code sometimes. in the future, refer to those generated diagrams and add important instructions to the prompt above to avoid those mistakes. examples are best. |
|
0 commit comments