本文へ移動
cccskills
無料GitHub で公開

ns-add-documentation

Add or update NowStack Mobile docs in docs/. Use when documenting architecture, release workflows, Convex/web/mobile patterns, setup, APIs, or tooling — or via `/ns docs`.

インストール方法を見る

含まれるファイル(4)

  • SKILL.md3.5 KB
  • references/documentation-format.md1.2 KB
  • scripts/create-doc.sh1.5 KB
  • templates/doc-template.md204 B

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Add Documentation — NowStack Mobile

<objective> Write or update repository docs in `docs/`, in this repo's house style: plain Markdown, grounded in real files and commands. This is NOT the public MDX docs tree from NowStack SaaS — no `/docs/[slug]` route, no MDX components. </objective> <workflow> 1. **See what already exists** (never assume — the doc set changes): ```bash ls docs/ docs/templates/ ``` Update an existing doc if one already covers the topic; only create a new file when nothing fits.
  1. Scope it before writing. Answer:

    • Who reads this — agent, developer, release operator, or support?
    • Which surface — convex/, web-app/, mobile-app/, store release, or shared site-config.ts?
    • What should the reader do differently after reading it?
    • Which command or file proves the guidance is still current?
  2. Create from the template so frontmatter and structure stay consistent:

    .agents/skills/ns-add-documentation/scripts/create-doc.sh <filename> "<title>" "<description>"
    # e.g. create-doc.sh web-app-routing "Web App Routing" "TanStack Start route conventions"
    

    Writes docs/<filename>.md from templates/doc-template.md.

  3. Fill it in — replace every TODO with real paths, exact steps, and real verification commands.

  4. Make it discoverable — link the new doc where a reader would look for it (a sibling doc, or the relevant .agents/rules/*.md / AGENTS.md entry). An unlinked doc is a doc nobody finds.

  5. Verify the commands you wrote actually run (see below), then report the path.

    </workflow>
<structure> ```md --- title: "Feature Or Workflow" description: "One sentence explaining the doc" ---

Feature Or Workflow

Purpose

What this solves and when it applies.

Relevant Files

  • path/to/real/file

Workflow

  1. Exact step.

Verification

Commands or manual checks that prove it works.

Notes

Caveats, secrets to keep out of git, release constraints.

Deeper conventions: [references/documentation-format.md](references/documentation-format.md).
</structure>

<rules>
- Ground every claim in a real repo file or command — no invented paths, routes, or flags.
- Commands must match `.agents/rules/development-commands.md`.
- Convex docs: state that agents must read `convex/_generated/ai/guidelines.md` before editing `convex/`.
- Cross-surface product/URL/auth/payment facts come from `site-config.ts`.
- Release docs: keep `asc`/`gpc`/screenshot conventions, and keep iOS/Android/store secrets out of git.
- Don't reintroduce the SaaS web-docs tree: no MDX-only components, no `/docs/[slug]`, no NowStack SaaS org routes.
</rules>

<verification>
Run only the checks matching the doc's surface:

```bash
npx convex dev --once               # Convex docs compile against the schema
cd web-app && npm run typecheck     # web docs
cd web-app && npm run build
cd mobile-app && npx tsc --noEmit   # mobile docs
cd mobile-app && npm run lint
cd mobile-app && npm run screenshots:store   # store/screenshot docs
</verification>

<success_criteria>

  • The doc lives in docs/, references only real repo paths, and its commands run.
  • It's linked from somewhere a reader will actually look.
  • No stale public-docs-tree, MDX-only, /docs/[slug], or NowStack SaaS assumptions remain. </success_criteria>

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Complete guide for building beautiful apps with Expo Router. Covers fundamentals, styling, components, navigation, animations, patterns, and native tabs.

日本語の概要は準備中です。原文の説明を表示しています。

Melvynx/saveit.now322026年10月10日 更新

convex

無料

Routes general Convex requests to the right project skill. Use when the user asks which Convex skill to use or gives an underspecified Convex app task.

日本語の概要は準備中です。原文の説明を表示しています。

Melvynx/saveit.now322026年10月10日 更新

Use when optimizing Convex database read bandwidth, documents-read cost, query indexes, full-table scans, function-level usage dashboard findings, or code that uses .filter(), unbounded .collect(), N+1 reads, or expensive reactive Convex queries.

日本語の概要は準備中です。原文の説明を表示しています。

Melvynx/saveit.now322026年10月10日 更新

Build reusable Convex components with isolated tables and app-facing wrappers. Use for defineComponent, app.use, ComponentApi, or shared backend modules.

日本語の概要は準備中です。原文の説明を表示しています。

Melvynx/saveit.now322026年10月10日 更新

Plan safe Convex schema and data migrations. Use for widen-migrate-narrow rollouts, backfills, breaking field changes, table splits, or failed schema deploys.

日本語の概要は準備中です。原文の説明を表示しています。

Melvynx/saveit.now322026年10月10日 更新

Audit Convex performance for hot reads, write contention, subscriptions, function limits, OCC conflicts, latency, read amplification, and expensive reactive queries.

日本語の概要は準備中です。原文の説明を表示しています。

Melvynx/saveit.now322026年10月10日 更新

Melvynx のスキルをすべて見る

このスキルの問題を報告する