docs(skills/ccc): document ccc describe and ccc guide#165
Merged
Conversation
Adds two sections to the `ccc` skill: - `Describing Files and Directories` — `ccc describe <path>` for per-file/dir summaries when the path is known. - `Concept Guides` — `ccc guide [slug]` for cross-cutting architectural docs (`.cocoindex_code/guides.yml`), plus an "Authoring guides.yml interactively" subsection that gives the agent a 5-step collaborative flow (survey → propose → iterate → write → generate) and a YAML schema reference. Inserts a `Following Hints in Search Output` subsection under search: when a hit is tagged `[summary]` or `[guide]`, follow the embedded `ccc describe`/`ccc guide` hint rather than running those commands proactively as a triage step. This reflects empirical finding that explicit guide-tier triage hurts (matched-vs-unmatched guide reads are net-neutral in aggregate); search-driven discovery is strictly better (~−34% tools, −26% time vs no-ccc on a 10-Q battery). Frontmatter trigger phrases extended to include `describe this file` and `read the concept guide`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ccc describeandccc guidein the skill, plus an authoring flow for.cocoindex_code/guides.yml.[summary]or[guide], follow the embeddedccc describe/ccc guidehint rather than running those commands proactively as a triage step.describe this fileandread the concept guide.This reflects an empirical finding from running the skill across two codebases: an explicit guide-tier triage is net-neutral at best (matched and unmatched guide reads cancel out in aggregate); search-driven discovery —
ccc searchranks guide chunks with a follow-up hint — is strictly better (~−34% tools, −26% time vs no-ccc on a 10-question battery).Test plan