| name | doc-generation |
| description | Use when generating or updating package documentation with ClaudeCreateDocumentation or ClaudeUpdateDocumentation. Covers resumption after limits, README structure, document queue ordering, and option usage. |
ããã¥ã¡ã³ãçæã«ãŒã«
GithubRepositories ã®ç·šéçŠæ¢ïŒå¿
é ïŒ
GithubRepositories/ é
äžã®ãã¡ã€ã«ã¯ç·šéããŠã¯ãªããªãã
$packageDirectory/GithubRepositories/<ããã±ãŒãžå>/ ã«çœ®ããããã¡ã€ã«ã¯ãããŒã«ã«ã® <ããã±ãŒãžå>_info/docs/ ãšã®å·®åãåã£ãŠ GitHub ãžã®æŽæ°ã³ãããã¡ãã»ãŒãžãäœæããããã®ãªãã¡ã¬ã³ã¹ãšããŠä¿æãããŠãããç·šéãããšå·®åã倱ãããã³ãããã¡ãã»ãŒãžã®äœæã¯ãŒã¯ãããŒãå£ããã
- â
ç·šéããŠããã®ã¯
<ããã±ãŒãžå>_info/docs/ 以äžã®ãã¡ã€ã«ïŒäŸ: ClaudeRuntime_info/docs/api.mdïŒ
- â
GithubRepositories/ClaudeRuntime/ClaudeRuntime_info/docs/api.md ãªã©ã¯ç·šéããªã
ãã®å¶çŽã¯ãClaudeUpdateDocumentation ã«ããèªåçæã»ClaudeUpdatePackage ã«ããããã±ãŒãžæŽæ°ã»æåã§ã®ããã¥ã¡ã³ãä¿®æ£ããããã®å Žåã«ãé©çšãããã
api.md ã®åœ¹å²ïŒæéèŠïŒ
api.md ã¯ããã±ãŒãžã®ãå¯äžã®çå®ã®ãœãŒã¹ãã§ããã LLM ããã®ãã¡ã€ã«ã ããèªãã§ãããã±ãŒãžã®å
šå
¬é颿°ãæ£ãã䜿ããã³ãŒããæžããªããã°ãªããªãã
api.md ã®ãã©ãŒãããååïŒLLM æé©åïŒ
api.md ã¯ãããèªãããã¥ã¡ã³ãã§ã¯ãªããLLM ãã³ãŒãçæã«äœ¿ãåç
§ãã¡ã€ã«ã§ããã
以äžã®ååã§ããŒã¯ã³æ¶è²»ãæå°åãã€ã€æ
å ±å¯åºŠãæå€§åãã:
- 空è¡ãæå°éã«ãã: ã»ã¯ã·ã§ã³èŠåºãåã®1è¡ã®ã¿ã颿°ãšã³ããªéã«ç©ºè¡ãå
¥ããªã
- ã»ãã¬ãŒã¿
--- ã䜿ããªã: ### èŠåºãã ãã§åºå¥ãã
- Bold/è£
食ãæå°éã«ãã:
**åŒæ°:** ãªã©ã®åé·ãªã©ãã«ã¯äžèŠ
- èªæãªäœ¿çšäŸãçç¥ãã:
NBCellCount[nb] ã®ãããªåçŽãªé¢æ°ã«äŸã¯äžèŠããªãã·ã§ã³ããã¿ãŒã³ãè€éãªé¢æ°ã«ã®ã¿äŸãä»ãã
- 1颿° = æå°è¡æ°: ã·ã°ãã㣠+ 説æ + ãªãã·ã§ã³ïŒããã°ïŒ+ æ»ãå€ãå¯ã«èšè¿°
api.md ã®å
·äœçãã©ãŒããã
宿°/倿°
### $VarName
å: Association, åæå€: <|"key" -> value|>
説ææïŒ1è¡ïŒ
åçŽãªé¢æ°ïŒãªãã·ã§ã³ãªãïŒ
### FuncName[arg1, arg2] â ReturnType
説ææïŒ1è¡ïŒ
ãªãã·ã§ã³ä»ã颿°
### FuncName[arg1, arg2, opts]
説ææïŒ1è¡ïŒ
â ReturnTypeïŒæ§é ã®èª¬æãå¿
èŠãªã远èšïŒ
Options: Opt1 -> Default1 (説æ), Opt2 -> Default2 (説æ)
è€éãªé¢æ°ïŒäŸãå¿
èŠïŒ
### FuncName[arg1, arg2, opts]
説ææ
â <|"Key1" -> ..., "Key2" -> ...|>
Options: Opt1 -> Default1 (説æ), Opt2 -> Default2 (説æ)
äŸ: FuncName["pkg", "msg", Branch -> "dev", Force -> True]
è€æ°ãã¿ãŒã³
### FuncName[a] / FuncName[a, b] / FuncName[a, b, c]
ãã¿ãŒã³å¥ã®èª¬æ
api.md ã«å¿
é ã®å
容:
- ãã¹ãŠã®å
¬é颿°: ã·ã°ããã£ãå
šãªãã·ã§ã³ïŒããã©ã«ãå€+説æïŒãæ»ãå€ã®å
- ãã¹ãŠã®å
¬é宿°/倿°: åãåæå€ã説æ
- è€éãªé¢æ°ã®ã¿: 䜿çšäŸïŒ1-2è¡ïŒ
- 颿°ã¯ã«ããŽãªå¥ã«ã°ã«ãŒãåïŒ
## ã«ããŽãªåïŒ
api.md ã®åç
§åªå
ã«ãŒã«:
- ã³ãŒãçææ: api.md â ãœãŒã¹ã³ãŒã ã®é ã§åç
§ïŒapi.md ã§è§£æ±ºã§ããã°ãœãŒã¹ã¯äžèŠïŒ
- 颿°ã®èª¬æãæ±ãããããšã: api.md â user_manual.md â ãœãŒã¹ã³ãŒã ã®é
- api.md ã«èšèŒãããŠããªã颿°ããªãã·ã§ã³ãæšæž¬ã§çæããŠã¯ãªããªã
api.md ã®æŽæ°æ¹éïŒæ¢å doc ãä¿å
šããŠåæïŒ
api.md / api_*.md 㯠æ¢åãã¡ã€ã«ããæŽæ°ãããïŒãœãŒã¹ããå®å
šåçæããŠäžæžãããªãïŒãçç±: æ¢åã® api doc ã«ã¯ãœãŒã¹ã³ãŒãããã¯å°åºã§ããªã人æã® proseïŒæŠèŠãèšèšããŒããèŠçŽãç¯ã®è§£èª¬ãworked exampleïŒãå«ãŸããŠããããããã¯ä¿å
šããªããã°ãªããªãã
æŽæ°ããã³ããïŒiBuildDocPrompt / iUpdateDocNextïŒã¯ CURRENT DOCUMENT ãå«ããLLM ã«æ¬¡ãæç€ºãã:
- ãœãŒã¹ç±æ¥ã§ãªã curated proseïŒæŠèŠã»èŠçŽã»äŸïŒã¯å¿
ãæ®ãã
- å
šé¢æ°ã·ã°ããã£ã»ãªãã·ã§ã³ã»ããã©ã«ãå€ãçŸãœãŒã¹ã«åæããççŸããèšè¿°ãä¿®æ£ããã
- ãœãŒã¹ã«æ°èŠè¿œå ãããå
¬é颿°/ãªãã·ã§ã³ã远èšãããœãŒã¹ããåé€ããããšã³ããªã®ã¿åé€ããã
- CURRENT DOCUMENT ã空ãªãããœãŒã¹ããå
šçæããã
- çµæã¯ CURRENT DOCUMENT ãšåç以äžã®å
å®åºŠã§ããããšïŒ
iSafeWriteDoc ã®ãµã€ãºéè¡ã¬ãŒããæ¢åã® 40% æªæºãžã®çž®å°ãæåŠããïŒã
â ïž æ§æ¹éïŒãGenerate ENTIRELY from source. Do NOT reference any prior version.ãïŒãœãŒã¹ããå®å
šåçæïŒã¯ 2026-06-25 ã«å»æ¢ãèããœãŒã¹ã® api doc ã§ curated prose ã倱ãããµã€ãºéè¡ã¬ãŒãã«åŒŸãããïŒãããã¯éŸå€è¶
ã§æ°ã¥ãã prose ãåªå€±ããïŒããããå¯äžã®çå®ã®ãœãŒã¹ãã§ããããšãšããœãŒã¹ããæ¯åäœãçŽãããšã¯å¥ç©ââæ¢å prose ãä¿ã¡ã€ã€ãœãŒã¹ã«åæããã
ããã¥ã¡ã³ããã¥ãŒã®é åºïŒå³å®ïŒ
README.md ã¯å¿
ãæåŸã«çæ/æŽæ°ãããããã¯çµ¶å¯Ÿçãªã«ãŒã«ã§ããã
$iDocQueue ããã³ ClaudeUpdateDocumentation ã®åŠçé åº:
- setup.md â ã€ã³ã¹ããŒã«æé æž
- user_manual.md â ãŠãŒã¶ãŒããã¥ã¢ã«
- api.md â API ãªãã¡ã¬ã³ã¹
- examples/example.md â 䜿çšäŸé
- README.md ïŒå¿
ãæåŸ: äžèš1-4ã®ææ°å
容ãåç
§ããŠæŠèŠãåæïŒ
README.md ãæåŸã«ããçç±
README.md ã¯ããã±ãŒãžã®æŠèŠææžã§ãããsetup.md / user_manual.md / api.md / examples ã®éèŠãªç¹ã®ãŸãšããšããŠæ©èœãããå
ã«çæãããš:
- ä»ããã¥ã¡ã³ãã«ãŸã æžãããŠããªãæ
å ±ãåç
§ã§ãããèšè¿°ãäžå®å
šã«ãªã
- ãœãŒã¹ã³ãŒã倿Žã®åæ ãä»ããã¥ã¡ã³ãçµç±ã§éæ¥çã«ããè¡ããããéèŠãªå€æŽç¹ãæãã
ã³ãŒãå
ã§ã¯ iEnsureReadmeLast ãã«ããŒãèªåçã« README.md ããªã¹ãã®æ«å°Ÿã«ç§»åãããiGuessTargetDocs ã®çµæã«ãé©çšãããã
ClaudeUpdateDocumentation ã§ã®æŽæ°é åº
ClaudeUpdateDocumentation å®è¡æãåãé åºãå³å®ãã:
- 1åŒæ°çïŒèªå差忀åºïŒ:
allDocs 㯠iEnsureReadmeLast ã§ README.md ãæ«å°Ÿã«ç§»å
- 2åŒæ°çïŒæç€ºä»ãïŒ:
iGuessTargetDocs ã®çµæã« iEnsureReadmeLast ãé©çš
- README.md ã®æŽæ°ããã³ããã«ã¯ãçŽåã«æŽæ°ãããä»ããã¥ã¡ã³ãã®ææ°å
容ãåç
§ã³ã³ããã¹ããšããŠå«ãŸãã
README.md ã®å¿
é æ§é ïŒå³å®ïŒ
README.md ã¯ä»¥äžã®æ§é ããã®é åºã§æããªããã°ãªããªã:
1. # ããã±ãŒãžå â èšèšææ³ãšå®è£
ã®æŠèŠ
- ããã±ãŒãžã®äžè¡èª¬æ
- ãªãããèšèšãããŠãããïŒWhyïŒ
- é«ã¬ãã«ã®ä»çµã¿ïŒHowïŒ
- ä»ããã¥ã¡ã³ããš design/ ãã©ã«ãã®ã¡ã¢ãåç
§ããŠæ§æ
2. ## 詳现説æ
以äžã®ãµãã»ã¯ã·ã§ã³ãå«ã:
- åäœç°å¢ (OS, Mathematica version, external tools)
- ã€ã³ã¹ããŒã« (UTF-8 ããŒããã¿ãŒã³å¿
é )
- ã¯ã€ãã¯ã¹ã¿ãŒã (æå°éã®åäœç¢ºèªã³ãŒã)
- äž»ãªæ©èœ (æ©èœäžèЧãšç°¡æœãªèª¬æ)
- ããã¥ã¡ã³ãäžèЧ (setup.md, user_manual.md, api.md, examples/ ãžã®ãªã³ã¯)
3. ## è¬èŸïŒAcknowledgments ãªãã·ã§ã³æå®æã®ã¿ïŒ
4. ## å
責äºé
ïŒå¿
é ïŒ
5. ## ã©ã€ã»ã³ã¹ïŒèšå®æžã¿ã®å Žåãå¿
ãæåŸïŒ
è¬èŸã»å
責äºé
ã»ã©ã€ã»ã³ã¹ã®é
眮ã«ãŒã«ïŒæéèŠã»å³å®ïŒ
è¬èŸïŒAcknowledgmentsïŒãå
責äºé
ïŒDisclaimerïŒãã©ã€ã»ã³ã¹ïŒLicenseïŒã¯ README.md ã®æ«å°Ÿã«ã®ã¿ååšããªããã°ãªããªãã
README.md æ«å°Ÿã®é åºïŒå³å®ïŒ:
## è¬èŸïŒAcknowledgments ãªãã·ã§ã³ãé空ã®å Žåã®ã¿ïŒ
## å
責äºé
ïŒå¿
é ïŒ
## ã©ã€ã»ã³ã¹ïŒå¿
é ãæåŸïŒ
çµ¶å¯ŸçŠæ¢äºé
:
- setup.md, user_manual.md, api.md, examples/example.md ã«è¬èŸã»å
責äºé
ã»ã©ã€ã»ã³ã¹ã®ã»ã¯ã·ã§ã³ã絶察ã«è¿œå ããŠã¯ãªããªã
- ãããã®ãã¡ã€ã«ã«æ¢ã«ãããã®ã»ã¯ã·ã§ã³ãååšããå Žåã¯ãåé€ããªããã°ãªããªã
- ã©ã€ã»ã³ã¹æ¡é
ã®ã³ããŒãè€æ°ãã¡ã€ã«ã«åæ£ãããšæŽåæ§ã厩å£ãããããREADME.md 以å€ã«ã©ã€ã»ã³ã¹ãèšèŒããããšã¯é倧ãªãã°ã§ãã
çç±:
- ã©ã€ã»ã³ã¹æ¡é
ã¯æ³çææžã§ãããè€æ°ç®æã«ååšãããšç管çã»ä¿®æ£æã«äžæŽåãçãã
- å
責äºé
ã»è¬èŸãåæ§ã«ãäžç®æã§ç®¡çãããªããã°ççŸãçºçãã
ã³ãŒãå®è£
:
iDocBuildAcknowledgmentsPrompt[], iDocBuildDisclaimerPrompt[], iDocBuildLicensePrompt[] 㯠README.md çææã«ã®ã¿ããã³ããã«æ¿å
¥ããã
- é README.md ãã¡ã€ã«ã®ããã³ããã«ã¯ãè¬èŸã»å
責äºé
ã»ã©ã€ã»ã³ã¹ã远å ãããªããšããæç€ºççŠæ¢æç€ºãå«ãŸãã
$iDocKeywords ã® README.md ãšã³ããªã«ã¯è¬èŸã»ã©ã€ã»ã³ã¹ã»å
責é¢é£ããŒã¯ãŒããå«ãŸããiGuessTargetDocs ããããã®æŽæ°æç€ºã README.md ã®ã¿ã«ã«ãŒãã£ã³ã°ãã
README.md ã®å¢çã«ãŒã«ïŒå¿
é ïŒ
- README.md ã¯ãè¬èŸãâãå
責äºé
ãâãã©ã€ã»ã³ã¹ãã§çµäºããããã以éã«ã³ã³ãã³ãã远å ããŠã¯ãªããªãã
- æç€ºæãããŒãããã¯ã³ã³ããã¹ãã®å
容ããã®ãŸãŸè»¢èšããŠã¯ãªããªãã
- README.md ã«åæ ããŠããã®ã¯ãããã±ãŒãžã®æŠèŠã»æ©èœäžèŠ§ã»æ§é ã«åœ±é¿ãã倿Žã®ã¿ã
ClaudeUpdateDocumentation ã®æŽæ°åäœïŒå¿
é ïŒ
å·®åããŒã¹ã®æŽæ°åå
- çŽåã®
_documentupdate ããã¯ã¢ãããããœãŒã¹ã³ãŒãå·®åãèªåæ€åºãã
- åããã¥ã¡ã³ãã¯æ¢åã®å
容ãèžè¥²ããå·®åã«å¯Ÿå¿ãã倿Žã®ã¿æ¿å
¥ãã
- æ¢åã®æ§é ã»èšè¿°ã倧å¹
ã«æžãæããŠã¯ãªããªãïŒå·®åã«é¢é£ããéšåã®ã¿ä¿®æ£ïŒ
README.md æŽæ°æã®ç¹å¥åŠç
- README.md æŽæ°æãããã³ããã«ã¯ä»ããã¥ã¡ã³ãïŒsetup.md, user_manual.md, api.md çïŒã®ææ°å
容ãåç
§ã³ã³ããã¹ããšããŠå«ãŸãã
- ãããã¯ãåç
§ã³ã³ããã¹ããã§ãããREADME.md ã«ã³ããŒãããã®ã§ã¯ãªã
- README.md ã«ã¯æŠèŠã¬ãã«ã®å€æŽã®ã¿ãåæ ããïŒæ°æ©èœåã®è¿œå ã¯å¯ã詳现ãªäœ¿ãæ¹ã®è»¢èšã¯äžå¯ïŒ
æŽæ°æç€ºã®ã¹ã³ãŒãã«ãŒã«ïŒå¿
é ïŒ
ClaudeUpdateDocumentation ã§è€æ°ããã¥ã¡ã³ããæŽæ°å¯Ÿè±¡ã«ãªãå Žåãåããã¥ã¡ã³ãã®æŽæ°æã«ã¯æç€ºæã®è©²åœéšåã®ã¿ãåæ ããããš:
- æç€ºæãç¹å®ããã¥ã¡ã³ãåãæç€ºããŠããå ŽåïŒäŸ:ãuser_manual ã«è¿œèšããapi.md ã®ã¿æŽæ°ãïŒãä»ã®ããã¥ã¡ã³ãã«ã¯ãã®è©³çްã転èšããªã
- README.md ã¯åžžã«æŠèŠã¬ãã«ã®å€æŽã®ã¿åæ ããïŒæ°æ©èœåã®äžèŠ§è¿œå ã¯å¯ã詳现ãªäœ¿ãæ¹ã®è»¢èšã¯äžå¯ïŒ
- æç€ºæãããŒãããã¯ã³ã³ããã¹ãããã®ãŸãŸããã¥ã¡ã³ãæ«å°Ÿã«è¿œèšãããäºæ
ã¯ãæç¢ºãªãã°ã§ãã
ãªãã·ã§ã³äžèЧ
ClaudeCreateDocumentation / ClaudeUpdateDocumentation ã®å
±éãªãã·ã§ã³:
| ãªãã·ã§ã³ | ããã©ã«ã | 説æ |
|---|
Fallback | False | Fallback ã¢ãã«äœ¿çš |
References | {} | åèæç®ã® URL / æžåãªã¹ã â README ã®ãåèæç®ãã»ã¯ã·ã§ã³ã«è¿œå |
Demos | {} | ãã¢åç»ã»äœ¿çšäŸã® URL ãªã¹ã â README ã®ã䜿çšäŸã»ãã¢ãã»ã¯ã·ã§ã³ã«è¿œå |
Disclaimer | {} | å
責äºé
ã«è¿œèšããæèšãªã¹ã |
Acknowledgments | {} | è¬èŸã»ã¯ã·ã§ã³ã«è¿œå ããæèšãªã¹ããé空ãªã README.md ã®å
責äºé
ã®åã«é
眮 |
License | "" | ã©ã€ã»ã³ã¹ããã¹ãã空ãªãMITèªåçæãæååæå®ã§ã«ã¹ã¿ã ã©ã€ã»ã³ã¹ |
TargetFiles | Automatic | æŽæ°å¯Ÿè±¡ãã¡ã€ã«ãæç€ºæå®ãAutomatic ãªãæç€ºæããèªåå€å®ã{"api.md", "install.md"} çã§ãã¡ã€ã«éå® |
Mode | "Update" | "Update" = æ¢åãå·®åæŽæ°ã"Create" = æ°èŠäœæïŒæ¢åå
容ãç¡èŠïŒ |
第äºåŒæ°ã®æç€ºæäžã« URL ãå«ãŸããŠããã°ãèªåçã« Demos ã«è¿œå ãããã
ããŒã¯ã³æ¶è²»ã®æé©å
$ClaudeDocModelïŒããã¥ã¡ã³ãå°çšã¢ãã«ïŒ
- ããã©ã«ã:
"claude-sonnet-4-20250514" â ããã¥ã¡ã³ãçæã¯ Sonnet ã¯ã©ã¹ã§åå
$ClaudeDocModel = "" ã§ $ClaudeModel ãšåãã¢ãã«ã䜿çš
- Create/Update/AutoApiUpdate ã®å
šãããŒã§èªåé©çšããã
ãœãŒã¹ã³ãŒãã®ãã£ã³ã¯å
- Update æµã§ã
iBuildChunkedSource ã«ãããã£ã³ã¯åãé©çšïŒä»¥åã¯ãœãŒã¹å
šæãæ¯åéä¿¡ããŠããïŒ
- å
¬ééšå + ããã¥ã¡ã³ãçš®å¥ã«é¢é£ããã»ã¯ã·ã§ã³ã®ã¿ãéä¿¡
- 550KB ã®ãœãŒã¹ã 60KB 以äžã«å§çž®ããã
çãã¹ã³ãŒãã®æŽæ°æç€º
iIsNarrowScopeInstruction ãã©ã€ã»ã³ã¹ã»å
責ã»è¬èŸã®ã¿ã®æŽæ°ãæ€åº
- 該åœããå ŽåãREADME.md æŽæ°æã«å
åŒããã¥ã¡ã³ãã®åç
§ãçç¥ïŒããã« 16KB ç¯çŽïŒ
iGuessTargetDocs ã®ãã©ãŒã«ããã¯
- ããŒã¯ãŒãã«ãããããªãå Žåãå
šãã¡ã€ã«ã§ã¯ãªã README.md ã®ã¿ã察象ã«ãã
- å
šãã¡ã€ã«æŽæ°ãå¿
èŠãªå Žå㯠1åŒæ°ç
ClaudeUpdateDocumentation["pkg"] ã䜿çšãã
æäœã«ãŒã«ïŒå¿
é ïŒ
| ããã¥ã¡ã³ã | æäœ | çç± |
|---|
| api.md | åžžäœïŒã ã»ã§ããèª¿ïŒ | ç°¡æœããåªå
ãããªãã¡ã¬ã³ã¹ææž |
| setup.md | æ¬äœïŒã§ãã»ãŸãèª¿ïŒ | ãŠãŒã¶ãŒåã説æ |
| user_manual.md | æ¬äœïŒã§ãã»ãŸãèª¿ïŒ | ãŠãŒã¶ãŒåã説æ |
| examples/example.md | æ¬äœïŒã§ãã»ãŸãèª¿ïŒ | ãŠãŒã¶ãŒåã説æ |
| README.md | æ¬äœïŒã§ãã»ãŸãèª¿ïŒ | ãŠãŒã¶ãŒåãæŠèŠã»çŽ¹ä» |
泚æ: $Language ã®èšå®ã«åºã¥ããŠèšèªã決å®ããããæ¥æ¬èªä»¥å€ãèšå®ãããŠããå Žåã¯ãã®èšèªã§åºåãããã
ããã¥ã¡ã³ãæžã蟌ã¿ã®å®å
𿩿§
iSafeWriteDoc ã«ããä¿è·ïŒããããã«è©²åœãããæžã蟌ãŸã $FailedïŒãã¡ã€ã«ã¯å€æŽããªãïŒ:
- ãµã€ãºéè¡ã¬ãŒã: æ¢åããã¥ã¡ã³ãã® 40% æªæºã«çž®å°ããå Žåã¯æåŠ
- ã¿ã€ãã«æŽåæ§ãã§ãã¯: README.md ã®å
é
# ã¿ã€ãã« ãããã±ãŒãžåãšäžèŽããªãå Žåã¯æåŠïŒLLM ãå¥ã®ããã¥ã¡ã³ãå
容ãè¿ããå Žåã®é²è·ïŒ
- åãè©°ãïŒtruncationïŒæ€åº (
iDocLooksTruncated): å¿çãéäžã§åããå Žåãæ€åºããŠæåŠããµã€ãº 40% ã¬ãŒããééããŠãå£ããããå¿
é ã確å®ãªå
åã®ã¿: â æªéãã³ãŒããã§ã³ã¹ïŒ``` ã奿°ïŒâ¡æã»æ§æã®éäžã§çµç«¯ïŒæ«å°Ÿãèªç¹ ã/ïŒ/, ãéãæ¬åŒ§ (/ïŒ/ãïŒã
倱ææã®åæ¢ïŒfail-fastïŒãšåéïŒresumptionïŒâ å¿
é
éäžå€±æã§ãå£ãããŸãŸç¶è¡ããåå®è¡ã§æŽæ°æžã¿ãã¡ã€ã«ãŸã§åçæãããäºæ
ãé²ããããClaudeUpdateDocumentation ã®æŽæ°ãã§ãŒã³ïŒiUpdateDocNextïŒã¯æ¬¡ã®ããã«åã:
- fail-fastïŒãã§ãŒã³å³äžæïŒ: ãããã¡ã€ã«ã®å¿çã
- ã·ã¹ãã ç倱æïŒAPI ãšã©ãŒ / å©çšå¶é / ãããã€ãå
éšãšã©ãŒ / 空å¿ç =
iIsAPIErrorResponseïŒããŸãã¯
- å質倱æïŒåãè©°ã / ãµã€ãºéè¡ / ã¿ã€ãã«äžæŽå =
iSafeWriteDoc ã $FailedïŒ
ã®ãããããªãããã®ãã¡ã€ã«ãæžãããæ®ãã®ãã¡ã€ã«ã«ãé²ãŸããã§ãŒã³å
šäœãäžæããã以åã¯å質倱æã skip ããŠæ¬¡ãžé²ã¿ããšã©ãŒãåºãŠãæŽæ°ãç¶ããŠããïŒããããã°ïŒãäžææããããŸã§ã«æåãããã¡ã€ã«ã¯ä¿å
šãããã
- resumptionïŒåéïŒ: æŽæ°ãµã€ã¯ã«ã¯ããœãŒã¹å
å®¹ïŒæç€ºïŒå¯Ÿè±¡ãã¡ã€ã«éåãã®ããã·ã¥
iDocCycleKey ã§èå¥ãããæåãããã¡ã€ã«ã¯ <docsDir>/.docupdate_progress.json ã«èšé²ããããäžæåŸã«åããœãŒã¹ç¶æ
ã§åå®è¡ãããšãæŽæ°æžã¿ãã¡ã€ã«ãã¹ãããããŠæ®ãããåéããããµã€ã¯ã«å®å
šå®äºæã«é²æãã¡ã€ã«ã¯ã¯ãªã¢ãããïŒæ¬¡åã¯ãœãŒã¹å€æŽã§æ°ãµã€ã¯ã«ïŒããœãŒã¹ãç·šéããã° cycleKey ãå€ããå
šãã¡ã€ã«åçæã
- ãã¹ãŠå®äºæžã¿ã§åå®è¡ããå Žåã¯ãæ¢ã«æŽæ°æžã¿ããšè¡šç€ºããŠäœãããªãã
倧éãã¡ã€ã«ã®äžŠåæŽæ°ïŒLLM 䞊åæå
¥ïŒ
SourceVault ã®ããã« README 以å€ãéŸå€ $iDocParallelThresholdïŒæ¢å® 5ïŒä»¥äž ã«ãªãæŽæ°ã§ã¯ãClaudeUpdateDocumentation ã¯é次ãã§ãŒã³ïŒiUpdateDocNextïŒã§ãªã 䞊åã³ãŒãã£ããŒã¿ iUpdateDocsParallel ã«æ¯ãåããå doc ã® LLM åŒã³åºãã䞊åæå
¥ããã
- ããã³ããæ§ç¯ã®å
±æ: 1 doc åã®ããã³ããã¯çŽé¢æ°
iBuildDocPrompt[sourceCode, pkg, docsDir, docFile, instruction, diffText, mode, designContext, splitCache] ãçµã¿ç«ãŠãïŒé次ã»äžŠåã§å
±æãREADME ã¯å
åŒ doc ããã£ã¹ã¯ããèªããããåŒã¶åã«å
åŒãæžã蟌ãŸããŠããå¿
èŠãããïŒã
- 䞊å床:
$LLMGraphMaxConcurrency["cli"]ïŒæ¢å® 3ïŒãiClaudeQueryAsyncWithProgressïŒclaudecode å
±æããŒãªã³ã°ïŒã«ãã¡ã³ã¢ãŠãããã®ã§ rule 95 æºæ ïŒç¬èª ScheduledTask ãäœããªãïŒã
- README ã¯å¿
ãæåŸ: README 以å€ãå
šãŠäžŠåã§æžã蟌ã¿çµããŠãããREADME ã 1 æ¬ã ãå®è¡ïŒæŽæ°æžã¿å
åŒãèªãã§æŠèŠçæïŒãREADME-last ã«ãŒã«ã䞊åã§ãå³å®ã
- fail-fast: ããããã® doc ã API ãšã©ãŒ/å質倱æãªãæ°èŠæå
¥ãæ¢ããé£è¡äžã drain ãããäžæïŒæååã¯ä¿åã»èšé²æžã¿ïŒã
- resumption: æå doc ã¯é²æèšé²ãããåå®è¡ã§æªå®äºåããåéïŒäžŠåã§ã Step 1 ã®ä»çµã¿ããã®ãŸãŸäœ¿ãïŒã
- ç»åæ·»ä»ïŒlist çïŒã¯é次ã®ã¿: media files ããããšãã¯äžŠååãã
iUpdateDocNextã
- å°æ°ïŒéŸå€æªæºïŒã¯é次ã®ãŸãŸïŒãªãŒããŒãããåé¿ïŒã
API ãšã©ãŒã»å©çšå¶éã®ä¿è·ïŒå¿
é ïŒ
- ãã¹ãŠã®ãã¡ã€ã«æžã蟌ã¿åã«
iIsAPIErrorResponse ã§ã¬ã¹ãã³ã¹ããã§ãã¯ããã
- ãšã©ãŒ/å¶éã¡ãã»ãŒãžã®å Žåããã¡ã€ã«ãäžåæŽæ°ãããšã©ãŒãå ±åããŠåæ¢ããã
- fail-fast åå: é£ç¶ API åŒã³åºãã§ã¯ãæåã®ãšã©ãŒã§ä»¥éã®åŒã³åºãããã¹ãŠã¹ãããããã
- 詳现ãªå€å®ãã¿ãŒã³ãšã³ãŒãäŸã¯
rules/90-api-error-handling.md ãåç
§ã
ã©ã€ã»ã³ã¹ã®èªåæ¿å
¥
License -> "" (ããã©ã«ã) ã〠GitHubREST$GitHubLicenseHolder` ãé空æååã®å Žå:
MIT ã©ã€ã»ã³ã¹ã README.md ã®æåŸïŒå
責äºé
ã®åŸïŒã«èªåæ¿å
¥ãããã
License -> "ã«ã¹ã¿ã ããã¹ã": æå®ããã¹ãããã®ãŸãŸã©ã€ã»ã³ã¹ã»ã¯ã·ã§ã³ã«æ¿å
¥ãããã
$GitHubLicenseHolder ã空æååã®å Žå: ã©ã€ã»ã³ã¹ã¯æ¿å
¥ããããèŠåã Print ãããã
setup.md / README.md ã®ã€ã³ã¹ããŒã«èšè¿°ïŒå¿
é ïŒ
$Path ã®ã«ãŒã«
- ãã¹ãŠã®
.wl ããã±ãŒãžã¯ $packageDirectory çŽäžã«é
眮ããã
$Path ã«è¿œå ããã®ã¯ $packageDirectory èªäœ
- æ£ãã:
AppendTo[$Path, $packageDirectory]
- 誀ã:
AppendTo[$Path, "C:\\path\\to\\PackageName"]
- claudecode ã䜿çšããŠããå Žåã¯èªåèšå®ããã
ããã±ãŒãžããŒããã¿ãŒã³
Block[{$CharacterEncoding = "UTF-8"},
Needs["PackageName`", "PackageName.wl"]];
ãªãããå°éæã®åäœ
iIsDocLimitError ã§ãªãããã¡ãã»ãŒãžãå€å®
- ãªãããæ€åºæ: åœè©²ãã¡ã€ã«ã¯ä¿åããã以éã®ãã¡ã€ã«çæã忢
- ããŒãããã¯ã«æªçæãã¡ã€ã«äžèЧã赀倪åã§è¡šç€º
ç¶ç¶ïŒãªã¶ã³ãã·ã§ã³ïŒã®åäœ
åŒã³åºãæã« iCheckDocResumption ã§ä»¥äžãå€å®:
- ãœãŒã¹ã documentupdate ããæ°ãã â å
šãã¡ã€ã«åçæ
- ãœãŒã¹ã documentupdate 以åã§ãäžéšãã¡ã€ã«ã®ã¿ååš â æªçæåã®ã¿çæ
- å
šãã¡ã€ã«ååš â å
šãã¡ã€ã«åçæ
Documentation` ããã±ãŒãžïŒdocumentation.wlïŒã®ç¹æ®ã»ã«ã¿ã€ã
Documentation` ããã±ãŒãžã¯ä»¥äžã®ç¹æ®ã»ã«ã¹ã¿ã€ã«ãæäŸããããããã¯ãã¡ã¿ã»ã«ããšåŒã°ãããšã¯ã¹ããŒãæã«åºåããé€å€ãããå±éã»ç¿»èš³ã»åæã®å¯Ÿè±¡ã«ããªããªãã
Note ã»ã«
- ã¹ã¿ã€ã«å:
"Note"
- çšé: èè
åãã¡ã¢ãåºåã«å«ãŸããªãã
Dictionary ã»ã«
- ã¹ã¿ã€ã«å:
"Dictionary"
- çšé: 翻蚳æã®çšèªå¯Ÿå¿èŸæžã圢åŒã¯ Mathematica ãªã¹ãåŒ:
{{<<Japanese>>, <<English>>, <<Context>>}, {"ç¶çž", "configuration", "ã»ã«ãªãŒãããã³"}, ...}
- 1è¡ç®ã¯ããããŒïŒ
<<>> ã§å²ãïŒã2è¡ç®ä»¥éããContext ã®æèã«ãããçšèªå¯Ÿå¿ãã衚ã
- LLM ããã³ããã«
=== Dictionary === ãããã¯ãšããŠèªå泚å
¥ããã翻蚳æã«çšèªã®å¯Ÿå¿ã匷å¶ãã
- å±éã»åææã«ãåç
§ãããïŒDirectives ãšåæ§ïŒ
Directive ã»ã«
- ã¹ã¿ã€ã«å:
"Directive"
- çšé: å±éã»ç¿»èš³ã»åæã®å®è¡æã« LLM ãé å®ãã¹ãæç€ºãèšèŒãã
- è€æ°ã® Directive ã»ã«ãé
眮å¯èœïŒå
šãŠåéãããŠçµåãããïŒ
- LLM ããã³ããã«
=== Directives === ãããã¯ãšããŠèªå泚å
¥ããã
- äŸ: ãæè¡çšèªã¯ååºæã«è±èªãæ¬åŒ§æžãã§äœµèšããããæäœã¯åžžäœïŒã ã»ã§ãã調ïŒã䜿çšããã
ã³ã³ããã¹ãåéã®ä»çµã¿
å±éã»ç¿»èš³ã»åæã®åæäœæãLLM ããã³ããã«ã¯ä»¥äžãé ã«æ¿å
¥ããã:
- Directives:
iDocCollectDirectives[nb] â å
š Directive ã»ã«ã®å
容
- Dictionary:
iDocCollectDictionary[nb] â å
š Dictionary ã»ã«ã®çšèªå¯Ÿå¿
- Document context:
iDocCollectContext[nb, cellIdx] â åšèŸºã»ã«ã®ããã¹ããšã¢ã¿ããã¡ã³ãæ
å ±
Export é€å€ããŒãã³ã°
- ä»»æã®ã»ã«ã«
$iDocTagExcludeExport ã¿ã°ãä»ããŠããšã¯ã¹ããŒãããé€å€ã§ãã
- ãã¬ããã®ãé€å€åæ¿ããã¿ã³ã§éžæã»ã«ã®é€å€ãã©ã°ããã°ã«ãã
- é€å€ã»ã«ã«ã¯å³åŽã«èµ€ãããŒã«ãŒ
à ã衚瀺ããã
- Note/Dictionary/Directive ã»ã«ã¯åžžã«é€å€ãããïŒã¿ã°äžèŠïŒ
ã»ã«åå² (DocSplitCell)
- ã«ãŒãœã«äœçœ®ã§ã»ã«ãååã»åŸåã«åå²ãã
- ãã©ã°ã©ã/翻蚳衚瀺äž: 衚瀺ããã¹ããã«ãŒãœã«äœçœ®ã§åå²ã翻蚳/ãã©ã°ã©ã/翻蚳å
ãæ¯çã§èªååå²ãããã³ãããããã°
$NBLLMQueryFunc ã§ååã»åŸåçšã«åçæ
- æ®éã®ã»ã«: ããã¹ããåçŽã«åå²
- ç§å¿ã»ã«ã®å Žåã¯
PrivacyLevel ã«åºã¥ã $ClaudePrivateModel ã«ã«ãŒãã£ã³ã°ããã
ã»ã«å䜵 (DocMergeCells)
- è€æ°éžæã»ã«ã®ããã¹ãã»ããã³ããã»ç¿»èš³ã»ç¿»èš³å
ãããããã¹ããŒã¹åºåãã§çµå
- æåã®ã»ã«ã«çµåçµæãæžã蟌ã¿ãæ®ãã®ã»ã«ã¯åŸãããé ã«åé€
- ã¢ãŒãã»ã¹ã¿ã€ã«ã¯æåã®ã»ã«ã®ãã®ãç¶æ
Bibliography ã»ã«
- ã¹ã¿ã€ã«å:
"Bibliography"
- çšé: åèæç®ãªã¹ãã®ç®¡çã圢åŒã¯ Mathematica ãªã¹ãåŒ:
{{<<Key>>, <<Author>>, <<Year>>, <<Title>>}, {"morita1996", "K. Morita", "1996", "Universality of..."}}
- Export æã« LaTeX ã§ã¯
\begin{thebibliography}...\end{thebibliography}ãMarkdown ã§ã¯ ## References ã»ã¯ã·ã§ã³ãšããŠèªååºå
- æ¬æäžã®
<<cite:key>> ã \cite{key} / [Author, Year](#ref-key) ã«èªå倿
å³ã¡ã¿ããŒã¿ (DocEditFigureMeta)
- ç»åã»ã«ã® TaggingRules ã«
figLabelïŒåç
§çšã©ãã«ïŒãš figCaptionïŒãã£ãã·ã§ã³ïŒãä¿å
- ãã¬ããã®ãå³ã¡ã¿ããã¿ã³ã§ãã€ã¢ãã°å
¥å
- Export æã« LaTeX ã§ã¯
\begin{figure}[h]\centerline{\includegraphics[scale=.8]{...}}\caption{...}\label{fig:...}\end{figure} ãåºå
- ã©ã¹ã¿ãŒç»å㯠PNGããã¯ã¿ãŒ/Mathematica èšç®ç»å㯠PDF ã§åºå
- ãã³ããªã³ã°ã¯
iDocBuildFigureTable ã§ Export æã«ã»ã«é ã§èªåä»çª
æ¬æäžã®åç
§èšæ³
<<fig:label>> â å³åç
§ïŒLaTeX: \figurename~\ref{fig:label}, Markdown: [Figure N](#fig-label)ïŒ
<<cite:key>> â åŒçšïŒLaTeX: \cite{key}, Markdown: [Author, Year](#ref-key)ïŒ
- åç
§è§£æ±ºã¯
iDocResolveReferences ã§ Export æã«å
šããã¹ãã»ã«ã«é©çš
ç·šé远跡ãšèªååæ
$iDocTagCleanText â ããã°ã©ã ãæžã蟌ãã ããã¹ãã®ã¯ãªãŒã³ã³ããŒã TaggingRules ã«ä¿å
iDocWriteAndTrack[nb, cellIdx, text] â ããã¹ãæžã蟌㿠+ ã¯ãªãŒã³ã³ããŒèšé²ã®äžæ¬ãã«ããŒ
- DocExpandIdea / DocTranslate ã® completionFn ã§ cleanText ãèªåèšé²
- DocToggleView å®è¡æã«
cleanText ãšçŸåšããã¹ããæ¯èŒããäžäžèŽãªãç·šéãããšå€å®
- ç·šéæ€åºæãåæ¿åŸã«
iDocPostToggleSync ãããã¯ã°ã©ãŠã³ãã§çºå:
- ãã©ã°ã©ãç·šé â 翻蚳ãåçæïŒ
iDocReTranslatePromptFnïŒ
- ããã³ããç·šé â ãã©ã°ã©ããåå±éïŒ
iDocReExpandPromptFnïŒ
- 翻蚳線é â ãã©ã°ã©ããéåæïŒ
iDocReverseSyncPromptFnïŒ
- ãã¹ãŠ
PrivacyLevel 察å¿ã§ç§å¿ã»ã«ã¯ $ClaudePrivateModel ã«ã«ãŒãã£ã³ã°
- åæãã¿ã³ã¯äžèŠã«ãªã£ããããã¬ããããå逿žã¿
Directive ã«ãããšã¯ã¹ããŒãæã¹ã¿ã€ã«èªã¿æ¿ã
- Directive ã»ã«å
ã«
{Subsection -> Section, Subsubsection -> Subsection} ã®ãã㪠Wolfram Language ã®ã«ãŒã«åŒãèšè¿°ãããšãMarkdown/LaTeX ãšã¯ã¹ããŒãæã«ã»ã«ã¹ã¿ã€ã«ãèªã¿æ¿ãããã
iDocParseStyleRemap[nb] ãå
š Directive ã»ã«ãèµ°æ»ãã{...->...} ãã¿ãŒã³ãæœåºã㊠<|"Subsection" -> "Section", ...|> ã® Association ãæ§ç¯
iDocTextCellToExport ã®åé ã§ style = Lookup[styleRemap, style, style] ãé©çš
- ã·ã³ãã«åïŒ
SubsectionïŒãæååïŒ"Subsection"ïŒãèªåçã«æååã«å€æããã
ç·šéæ€åºã®ã¢ãŒãäžèŽãã§ãã¯ïŒãã°ä¿®æ£ïŒ
$iDocTagCleanMode â ããã¹ãæžãèŸŒã¿æã®ã¢ãŒãç¶æ
ã "paragraph:False" ã®ãããªæååã§èšé²
wasEdited ãã§ãã¯æã« cleanMode === currentMode ãæ€èšŒãã¢ãŒããå€ãã£ãŠããã° cleanText ã¯åã¢ãŒãã®æ®çå€ãšããŠç¡èŠããã
iDocShowAllAsïŒäžæ¬è¡šç€ºåæ¿ïŒã®å
šæžã蟌ã¿ç®æã« $iDocTagCleanText 远跡ã远å
DocTranslate ã®ãã£ãã·ã¥è¡šç€ºãã¹ïŒLLM äžèŠã®å³æè¡šç€ºïŒã«ã远跡ã远å
- æ§ã»ã«ïŒcleanMode æªèšå®ïŒã¯
StringQ[cleanMode] = False â wasEdited = False ãšãªãå®å
š
DocExportWordïŒWord ãšã¯ã¹ããŒãïŒ
DocExportMarkdown ã§ Markdown ãçæããPandoc ã§ .docx ã«å€æ
ProcessDirectory -> outDir ã§ Pandoc ãç»åãã©ã«ãå
ã§å®è¡ããçžå¯Ÿãã¹ã®ç»åã確å®ã«è§£æ±º
--from=markdown+implicit_figures ã§ {#label} ãå³ãšããŠèªè
- ãªãã·ã§ã³
"ReferenceDoc" -> "template.docx" ã§ã¹ã¿ã€ã«ãã³ãã¬ãŒããæå®å¯èœ
ãšã¯ã¹ããŒãæã®èšèªçµ±äž
iDocDetectExportLanguage[nb] â 翻蚳衚瀺ã»ã«ãéåæ°ãªã翻蚳ã¿ãŒã²ããèšèªãè¿ã
- 翻蚳ã¢ãŒãæ€åºæããšã¯ã¹ããŒããã€ãã©ã€ã³å
šäœã§ã¿ãŒã²ããèšèªã«çµ±äž:
- æç®ã¿ã€ãã«:
iDocTranslateBibTitle ãæ¥æ¬èªã¿ã€ãã«ãæ€åºããPDF ããã¹ãããè±èªã¿ã€ãã«ãæ¢ãã LLM ã§ç¿»èš³
- å³ãã£ãã·ã§ã³:
iDocTranslateFigCaption ãã¿ãŒã²ããèšèªã«ç¿»èš³
exportLang ãã©ã¡ãŒã¿ã iDocCellToExport â iDocOutputCellToExport â bib åºåãŸã§äžè²«ããŠäŒæ¬
- Markdown / LaTeX / WordïŒPandocçµç±ïŒãã¹ãŠã«é©çš