AgentStack
Browse Sign in
Browse Why AgentStack Sell Docs
Sign in
SKILL verified MIT Self-run

Docs Writer

skill-byerlikaya-claude-starter-kit-docs-writer · by byerlikaya

|

No reviews yet
0 installs
38 views
0.0% view→install

Install

$ agentstack add skill-byerlikaya-claude-starter-kit-docs-writer

✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.

Security review

✓ Passed

No issues found. Passed automated security review. · v0.1.0 How review works →

  • Prompt-injection patterns
  • Secret / credential exfiltration
  • Dangerous shell & filesystem operations
  • Untrusted network calls
  • Known-malicious package signatures

What it can access

  • Network access No
  • Filesystem access No
  • Shell / process execution No
  • Environment & secrets No
  • Dynamic code execution No

From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.

View the full security report →

Verified badge

Passed review? Show it. Paste this badge into your README, it links to the public security report.

AgentStack Verified badge Links to your public security report.
[![AgentStack Verified](https://agentstack.voostack.com/badges/verified.svg)](https://agentstack.voostack.com/security/report/skill-byerlikaya-claude-starter-kit-docs-writer)

Reliability & compatibility

Security review passed
0 installs to date
no reviews yet
2mo ago

Declared compatibility

Claude CodeClaude Desktop

Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.

Preview Execution monitoring

We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.

How agent discovery & health will work →
Are you the author of Docs Writer? Claim this listing to set pricing, connect Stripe payouts, and keep 70% of every sale.
Sign up to claim

About

Documentation

Goal: the docs must match the code. Wrong/stale docs are worse than no docs (they inspire trust and mislead). Trigger: when a public API, command, configuration, or user-visible behavior changes.

When it is mandatory

  • A public function/endpoint/CLI signature or behavior changed.
  • A new feature, configuration key, or environment variable was added.
  • The install/run steps changed.
  • A breaking change was made (also coordinate via release/CHANGELOG).

Checklist

  • [ ] Docs are up to date for the changed public surface
  • [ ] Examples work (copy-paste tested / mentally traced)
  • [ ] Dead/misleading wording removed (no leftover old name/parameter)
  • [ ] New configuration/env documented (default + whether required)
  • [ ] Scope minimal — not a repetition of the code, but "why/how to use it"
  • [ ] No secret/real credential in the docs (use a placeholder)

How

  1. Identify the changed surface — extract the public signature/behavior diff from the diff.
  2. Find the right doc — README, docs/, docstring, OpenAPI, command --help. If there is more than one, update them all.
  3. Write: what it does · how it is called (example) · input/output · limits/error cases. Short and correct.
  4. Verify the examples — does the command/code example actually run.
  5. Clean up the old — delete references to removed APIs/parameters.
  6. Translation: if the user-visible doc is multilingual, coordinate with i18n-integrity.

Principles

  • Single source — behavior lives in the code; the doc explains it, does not copy it (a copied doc goes stale).
  • Example > paragraph — a working example beats three paragraphs.
  • Minimal — don't write a giant doc no one will maintain; answer the most-asked question.

Invariant rules

  1. Correctness > completeness — don't write a wrong doc; if unsure, flag it/ask.
  2. Examples must work.
  3. Leave no stale/dead docs.
  4. No secret/real credential — use a placeholder (aligned with §4).
  5. Don't repeat the code — don't just copy the signature; explain the usage.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

Install and usage instructions live in the source repository linked above.

Reviews

No reviews yet, be the first.

Versions

  • v0.1.0 Imported from the upstream source.