# Docs

> Use when editing Vico guide documentation, Markdown guide prose, API reference–linked prose, or documentation pages. Applies to wording changes in `guide/` and documentation copy for Vico’s APIs.

- Skill: `patrykandpatrick/docs` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add patrykandpatrick/docs`
- Raw SKILL.md: https://api.skillmd.com/api/skills/patrykandpatrick/docs/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: patrykandpatrick (https://skillmd.com/u/patrykandpatrick)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/patrykandpatrick/docs

---


# Docs

## Guide prose rules

When editing Vico guide prose:

1. Link first mentions on each page. The first mention of a code element should
   link to the API reference.
2. Avoid nounifying code names. Do not use code element names as generic count
   nouns, such as “a `Foo`,” “the `Bar`,” or plural forms like “`Baz`s.” Attach
   articles to generic nouns instead, such as “a `Foo` instance.”
3. Distinguish classes from instances. If prose refers to an object, say
   “instance” or use a generic noun such as “chart,” “model,” “layer,”
   “marker,” or “transaction.” Introduce the code element name separately when
   needed.
4. Prefer generic nouns for concepts. Use ordinary language for the concept
   under discussion, and reserve code names for precise API references.
5. Keep terminology parallel. In comparisons and lists, phrase equivalent ideas
   symmetrically.

## Editing workflow

1. Identify the target guide page or documentation copy.
2. Make the requested prose changes, keeping the surrounding terminology and API
   references consistent.
3. Check first mentions of code elements after edits, because moved or rewritten
   text can change which mention is first on the page.
4. Review the edited paragraphs for code-name nounification and
   class–instance ambiguity before finishing.

