본문으로 건너뛰기
cccskills
무료GitHub에 공개

docs-check

Verify documentation keeps up with a code change in dynamic-neural-field-composer - Doxygen on public API, the matching wiki page, and stale references elsewhere. Use before opening a PR, or when asked whether docs need updating.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

설치 방법 보기

포함된 파일(1)

  • SKILL.md2.6 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

Docs check

Three passes over git diff origin/main...HEAD. Report findings; do not silently rewrite prose that is merely different from how you would put it.

Pass 1 - Doxygen

Scope: new or changed public entities under dynamic-neural-field-composer/include/.

Each needs:

  • @brief - one line, what it does
  • one @param per parameter, names matching the signature exactly
  • @return unless the return type is void

Flag three failure modes:

  • Missing - new public function/class/struct with no block.
  • Stale - a parameter was renamed, added or removed and the block still describes the old signature. This is the most common and the easiest to miss.
  • Wrong - the description contradicts what the code now does.

Private helpers in src/ do not need Doxygen.

Pass 2 - Wiki

dynamic-neural-field-composer/wiki/ has 15 pages. Map the change to its page:

ChangedPage
Element behaviour, new element typeElements.md, Element Reference.md
Element parameters, tuning defaultsElement Reference.md, Parameter Tuning Guide.md
GUI, windows, node editorApplication and UI.md
Simulation loop, timing, recorderSimulation.md
Plots, heatmaps, visualizationVisualization.md
Build, dependencies, setupGetting Started.md, Troubleshooting.md
Public API shape, architectureArchitecture.md, How to Add New Elements.md
New example executableExamples.md, How to Create and Run Your Own Example Executable.md
Test infrastructureTesting.md

Rule of thumb: if a user could notice the change without reading the source, a wiki page owes them an explanation. Pure internal refactors do not.

Pass 3 - Stale references

Grep the repo for references the change invalidated:

grep -rn "<old_symbol>" README.md CONTRIBUTING.md CHANGELOG.md dynamic-neural-field-composer/wiki/ .claude/

Look for renamed or removed symbols, moved file paths, changed build commands or flags, and example snippets that no longer compile. Check README.md and CONTRIBUTING.md specifically when the build process or directory layout moved.

Output

For each pass: either "clean" or a concrete list of file + line + what is wrong. If nothing in the diff touches public API or user-visible behaviour, say so and stop - a refactor with no API change legitimately needs no doc update.

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

autopilot

무료

Orchestrate unattended resolution of open GitHub issues - triage by complexity, dispatch parallel worker agents into isolated worktrees, review their diffs, open PRs, and monitor CI and CodeRabbit until green. Use when asked to work through open issues autonomously or put Claude on auto-pilot.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

Jgocunha/dynamic-neural-field-composer182026년 10월 9일 업데이트

Configure, build and test dynamic-neural-field-composer. Use whenever you need to compile the library, run the GoogleTest suite, verify a change builds, or reproduce a test failure.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

Jgocunha/dynamic-neural-field-composer182026년 10월 9일 업데이트

commit

무료

Read the uncommitted diff in dynamic-neural-field-composer and print conventional commit message(s) for it, grouped by logical change. Use when asked to write, suggest or draft a commit message, or "what should I commit this as".

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

Jgocunha/dynamic-neural-field-composer182026년 10월 9일 업데이트

Check a change for performance regression against this machine's recorded baseline - decide whether the diff needs checking, run the deck benchmark under the hygiene wrapper, and attribute any regression to an element. Use before opening a PR that touches the simulation hot path.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

Jgocunha/dynamic-neural-field-composer182026년 10월 9일 업데이트

pr

무료

Read the branch diff in dynamic-neural-field-composer and print a PR title and description in chat, filling the repo's pull request template. Use when asked to write, draft or suggest a PR title/description, or "what should the PR say".

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

Jgocunha/dynamic-neural-field-composer182026년 10월 9일 업데이트

Review a diff against dynamic-neural-field-composer's own standards - backwards compatibility, Clean Code, tools/ helper reuse, C++20 idiom, hot-path performance, and test coverage. Use before opening a PR or when asked to review a branch or change.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

Jgocunha/dynamic-neural-field-composer182026년 10월 9일 업데이트

Jgocunha의 스킬 모두 보기

이 스킬의 문제 신고