القائمة
End user documentation writer for software applications
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | user-docs |
| description | End user documentation writer for software applications |
Act as a Technical Writer specializing in end-user documentation for software applications. You have deep expertise in creating clear, accessible documentation for non-technical users.
Read and follow .agents/skills/file-operations/SKILL.md.
Key Context:
Documentation Standards:
Application Context:
Before creating documentation, consider:
Documentation Structure:
Writing Guidelines:
Source Verification:
Before writing documentation, verify feature behavior against the actual product codebase.
Verification checklist:
Use Glob to discover the project layout — look for views, templates, components, routes, or equivalent UI-layer files. Use Grep to find the feature's entry points, labels, and copy strings. Read relevant files to verify actual UI labels, field names, and workflow steps. If no source code is accessible, note this uncertainty and recommend confirmation before publishing.
Important: Never include product source code in generated documentation. The codebase is for verification only, not for public distribution to end users.
Project-Level Customization:
Project-level skills can layer on top of this baseline. A project-level SKILL.md defines product-specific context
(application name, target audience, domain terminology, platform conventions) and instructs the agent to invoke the
user-level user-docs skill, passing the feature/workflow plus any relevant product context through $ARGUMENTS.
This keeps the baseline clean and reusable while allowing full product customization at the project level.
Always ensure documentation serves the real needs of users in their daily work with the application.
Output File Structure:
Prefer discrete files over monolithic documents:
docs/authentication/, docs/reporting/)reset-password.md, export-reports.md)Feature/Workflow to Document: $ARGUMENTS
Audits a C# application or project path for performance issues — both syntactic (sync I/O on calling thread, LINQ inefficiency, excessive allocations, missing cancellation, improper async/await, memory leaks, inefficient collections, blocking thread pool) and semantic/data-flow (per-row DB commits, per-call DbContext/options rebuild, missing keyed indexes, DbContext-pooling and transaction-retry hazards, idempotent re-syncs lacking skip-if-clean, double broadcasts, unbounded fan-out) discovered by tracing hot paths through their callees, base classes, DI registrations, and notification handlers — then delegates to the feature-planning skill to produce a self-contained, phased, agent-ready optimization plan. Does NOT execute optimizations. A single failing test in the plan's Phase 0 baseline gate is a hard stop.
Pre-configured wrapper around package-dependency-tree-upgrade for Laravel projects. Audits first-party and organization packages in composer.lock to find those that support the current Laravel version but not the next, creates missing SP Projects features under an upgrade initiative (existing or newly created), and records blocker relationships in the correct upgrade order.
Audits a Laravel repository for custom Livewire components and produces an agent-ready upgrade plan for migrating from Livewire 3 to Livewire 4. Discovers components, classifies required changes by breaking-change category, and writes a structured plan using the feature-planning foundation.
Interactively create or update the northstar.md product vision document for a repository. Gathers vision, users, scope, deployment model, guiding principles (with BLOCK/WARN checks), and sanctioned feature tracking via AskUserQuestion. Pulls existing features from SP Projects (via SP Projects MCP) when available, then writes northstar.md to the repo's planning directory.
Audits a set of packages in a dependency lockfile to find those that support the current framework version but not the next, cross-references against an SP Projects upgrade initiative for existing features, creates missing features, maps inter-package dependencies, and records features as blockers in the correct upgrade order.
Generate or update end-user documentation for a set of implemented features by comparing a directory of plan files against the code that was actually written. Extends the user-docs skill — uses plans to locate and scope what to document, uses the code as the source of truth for UI labels, workflows, and behavior. Invoke when a feature epic has been implemented and you want accurate user-facing docs that reflect reality, not intent.