phowell
/
pocketflow
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update the guide

This commit is contained in:
zachary62 2025-03-10 16:36:01 -04:00
parent 1818d5e26e
commit bf46ad9d83
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/guide.md
View File

@ -48,16 +48,16 @@ These system designs should be a collaboration between humans and AI assistants:
4. **Data Design**: Plan how data will be stored and updated. 4. **Data Design**: Plan how data will be stored and updated.
- For simple systems, use an in-memory dictionary. - For simple systems, use an in-memory dictionary.
- For more complex systems or when persistence is required, use a database. - For more complex systems or when persistence is required, use a database.
- **Remove Data Redundancy**: Don't store the same data. Use in-mem reference or foriegn key. - **Remove Data Redundancy**: Don’t store the same data. Use in-memory references or foreign keys.
- For each node, design its access pattern: - For each node, design its access pattern:
- `type`: Decide between Regular, Batch, or Async - `type`: Decide between Regular, Batch, or Async
- `prep`: How the node reads data - `prep`: How the node reads data
- `exec`: Which utility function this node use - `exec`: Which utility function this node uses
- `post`: How the node writes data - `post`: How the node writes data
5. **Implementation**: Implement the intial nodes and flows based on the design. 5. **Implementation**: Implement the initial nodes and flows based on the design.
- **"Keep it simple, stupid!** Avoid complex features and full-scale type checking. - **“Keep it simple, stupid!”** Avoid complex features and full-scale type checking.
- **FAIL FAST**! Refrain from `try` logic so you can quickly identify weak points in the system. - **FAIL FAST**! Refrain from `try` logic so you can quickly identify any weak points in the system.
- Add logging throughout the code to facilitate debugging. - Add logging throughout the code to facilitate debugging.
6. **Optimization**: 6. **Optimization**: