AGENT SKILL

documentation

Owns how any document is written, with its sentences, terms, paragraphs and lists, and what a README holds. Use before writing or changing a technical document, README or doc comment; instructions for an agent add the prompting skill's rules.

License 许可
MIT
所属仓库
samchon/automovie
最近更新
2026-11-15
Stars
★ 15
Forks
3

01 前言 Front Matter

name
documentation
description
Owns how any document is written, with its sentences, terms, paragraphs and lists, and what a README holds. Use before writing or changing a technical document, README or doc comment; instructions for an agent add the prompting skill's rules.

02 资源文件 1

03 SKILL.md 正文

Documentation

Good writing is the same for every reader: deliver the core point concisely and clearly. Only the reader, and so what the reader needs, differs by document.

Every document follows Writing. A README adds the rules below.

READMEs

Write a README from the view of the person who uses its project or package, and keep it to the essentials:

  • what it is and when to use it;
  • how to install and start it;
  • the few entry points;
  • where the detail lives.

A README lists no API that the source and its types already own, because that list goes stale at the next change, and it carries nothing only a maintainer needs. Every name, command and sample in it exists in the code, and every sample runs.

Doc comments

The project's development skill names what a public declaration's comment must say.

04 同仓库更多 Skills