best-practices

Featured

Use when about to choose, configure, or refine a tool, library, config format, API pattern, or project setup, or before proposing a design of your own — research current guidance, pitfalls, and prior art first; already knowing an approach, or assuming no prior art exists, is not an exemption. Also use when the user asks about best practices, gotchas, or recommended patterns

DevOps & Infrastructure 138 stars 25 forks Updated today MIT

Install

View on GitHub

Quality Score: 90/100

Stars 20%
71
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Best Practices Answer two questions from current sources: **what's the recommended way**, and **what bites people** (the gotchas and pitfalls around it). A how-to without its pitfalls is half an answer. ## Two-Phase Rule - **Phase 1: Research.** Dispatch find-docs and/or WebSearch queries. - **Phase 2: Synthesize and act.** Starts only after Phase 1 results arrive. The user's argument may be a question or an imperative. Imperatives ("refine X", "set up Y") determine what Phase 2 does, not whether Phase 1 happens. Phase 1 always runs. **Rationalizations that precede skipped research:** | Thought | Reality | | ------------------------- | -------------------------------------------------------------------------------------- | | "I already know this" | Training data goes stale. Config keys get renamed, APIs get deprecated. | | "The user said to act" | The imperative scopes Phase 2, it does not eliminate Phase 1. | | "This is a simple lookup" | A 30-second search costs nothing. A wrong recommendation costs a debugging round-trip. | ## Workflow ### 1. Identify Research Targets Break the topic into 2-4 specific queries. Dedicate at least one query to pitfalls ("common mistakes with X", "X gotchas in production"): pitfalls live in issue threads, migration guides, and post-mortems, not in getting-started docs, so a how-to query won'...

Details

Author
vinta
Repository
vinta/hal-9000
Created
10 years ago
Last Updated
today
Language
Python
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category