Skip to content

feat(docs): Add prompting guideline #427

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.

Sign up for GitHub

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

Open
jinsyl123 wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat(docs): Add prompting guideline #427

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f09410e
docs: add prompting guideline
actions-user Sep 24, 2025
f7298ca
docs: refine prompting guideline examples
actions-user Sep 24, 2025
4c64953
fix(docs): resolve build errors in prompting guideline
actions-user Sep 24, 2025
f368c87
fix(docs): clarify and correct prompting guidelines
actions-user Sep 28, 2025
60f3e36
Adjust intro section.
gyxlucy Sep 28, 2025
26f8ac7
docs: add links to prompting guideline
actions-user Sep 29, 2025
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
10 changes: 8 additions & 2 deletions packages/docs/content/docs/prompting-guideline.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@ This guide offers practical strategies to boost development workflows.
- **Provide Clear Context:** Use `@` to reference files/folders (e.g., `@api.js`) or `README.pochi.md` for project rules and goals (e.g., coding standards, security priorities).
- **Break Down Tasks:** Split complex problems into steps for stability (e.g., review, then optimize).
- **Ensure Consistency:** Rely on structured prompts (XML/JSON) for repeatable, predictable outputs.
- **Iterate Safely:** Tweak prompts step-by-step, using structure to revert changes if needed.
- **Leverage Pochi Features:** Use `~/.pochi/config.jsonc` for models & MCPs, `README.pochi.md` for agents/rules, Pochi Cloud for shared histories, GitHub/Slack for team work.
- **Iterate Safely:** Tweak prompts step-by-step. Using structured formats like XML or JSON for your prompts makes it easier to track and revert changes if needed.
- **Leverage Pochi Features:**
- Use `~/.pochi/config.jsonc` for models & MCPs.
- Use `README.pochi.md` for project-specific rules.
- Use `.pochi/workflows/` for custom workflows.
- Use `.pochi/agents/` for custom agents.
- Use Pochi Cloud for sharing task histories.
- Use the GitHub & Slack integrations for team collaboration.

## How to Prompt Pochi

Expand Down