documentation

SKILL.md

Create clear, useful documentation that helps people understand and use your code.

Purpose: Help users understand what the project does and how to use it

const result = functionName('hello', 10) console.log(result) // "hello repeated 10 times"

README、API ドキュメント、インライン コメント、技術ガイドなどのドキュメントを作成または更新するときに使用します。対象読者にとってのわかりやすさと有用性に重点を置いています。 ソース: thebushidocollective/han。

原文を見る