agentleFS
Sign inStart free
guojin-yanguojin-yan/DeploySharp/.agents/skills/deploysharp-documentation/SKILL.md

deploysharp-documentation

Skill179 starsChanged 12 days agoApache-2.0View on GitHub

Create, simplify, or review DeploySharp README, tutorials, support matrices, release notes, and maintainer documentation. Use for repository documentation work; keep tutorials detailed and development chronology out of public docs.

The file

We split this skill into the rules it gives an agent

10 rules. About 0 are common, 7 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Write for library users first and maintainers second.

    line 8
  2. Distinctive:

    Keep the root README concise: project value, current release, package badges, quick code, supported platforms/models, tutorial links, …

    line 12
  3. Distinctive:

    Keep task tutorials detailed enough to complete a realistic workflow, including ownership, cancellation, error handling, configuration, and …

    line 13
  4. Distinctive:

    Keep architecture, compatibility, validation, and maintainer pages concise.

    line 14
  5. Very specific:

    Put exact per-model backend status in docs/model-backend-verification-matrix.md and performance summaries in …

    line 16
  6. Very specific:

    Never use a local absolute path in user instructions.

    line 20
  7. Very specific:

    Do not link to temporary reports, raw TRX/CSV/JSON, generated engines, private machines, or files excluded from the public repository.

    line 21
  8. Distinctive:

    Do not claim all models or backends from a representative test.

    line 23
  9. Distinctive:

    Keep English and Chinese README structure and links aligned without forcing literal translation.

    line 24
  10. Distinctive:

    After edits, verify every local Markdown/HTML link, YAML and JSON syntax, README anchors used by samples, documentation build when …

    line 31

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

DeploySharp Documentation

Write for library users first and maintainers second. Public docs explain how to install, configure, run, troubleshoot, and reproduce current behavior; they are not a diary of development experiments.

Information Architecture

  • Keep the root README concise: project value, current release, package badges, quick code, supported platforms/models, tutorial links, performance link, license, and contact.
  • Keep task tutorials detailed enough to complete a realistic workflow, including ownership, cancellation, error handling, configuration, and limitations.
  • Keep architecture, compatibility, validation, and maintainer pages concise. State the current contract and decision, not every dated attempt.
  • Maintain one canonical page per subject. Merge "getting started", "compatibility", "security", and CLI pages when they describe one small component.
  • Put exact per-model backend status in docs/model-backend-verification-matrix.md and performance summaries in docs/articles/device-performance-benchmarks.md.

Content Rules

  • Never use a local absolute path in user instructions. Use repository-relative paths, placeholders, or Path.Combine/Join-Path examples.
  • Do not link to temporary reports, raw TRX/CSV/JSON, generated engines, private machines, or files excluded from the public repository.
  • Distinguish supported, preview, unverified, unsupported, smoke, parity, accuracy, and performance.
  • Do not claim all models or backends from a representative test.
  • Keep English and Chinese README structure and links aligned without forcing literal translation.
  • Preserve useful API examples and real constraints when deleting historical prose.

Development audits and chronological evidence belong outside the public repository when an approved archive exists. Do not move or delete such files without checking references and preserving unrelated work.

Validation

After edits, verify every local Markdown/HTML link, YAML and JSON syntax, README anchors used by samples, documentation build when available, and git diff --check. Report deleted/merged pages and the canonical replacement so maintainers can update external links.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free