creating-end-user-documentation-for-packmind

Solid

Create or update user-focused Packmind documentation in `apps/doc/` that explains features in clear task-oriented language without technical implementation details. Use this skill whenever the user asks to document a feature, write or update user guides, create end-user docs, explain how something works for users, or convert developer-focused docs to user-friendly guides — even if they don't say "documentation" explicitly. Trigger on any request to explain, guide, or describe Packmind features from a user perspective.

Data & Documents 314 stars 20 forks Updated yesterday Apache-2.0

Install

View on GitHub

Quality Score: 86/100

Stars 20%
83
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

Create clear and concise end-user documentation for Packmind features to empower users in accomplishing their tasks effectively while avoiding unnecessary technical details. ## Scope All documentation modifications MUST only be made within the `apps/doc/` folder, which contains the official Packmind end-user documentation. Do not modify any other documentation files outside this directory. ## Context Validation Checkpoints * [ ] Have you analyzed the codebase to understand the feature thoroughly (backend API, packages, frontend, MCP server)? * [ ] Have you reviewed existing documentation in `apps/doc/` to understand the structure? * [ ] Do you know whether you need to create a new file or update an existing one within `apps/doc/`? * [ ] Have you identified what users need to accomplish versus what developers need to know? ## Recipe Steps ### Step 1: Analyze the Codebase Before writing any documentation, thoroughly understand the feature by analyzing backend API controllers and endpoints, packages domain logic and use cases, frontend UI components and forms, and MCP server tools and their parameters. Focus on identifying user-facing functionality versus internal processes. ### Step 2: Review Existing Documentation Read all existing files in `apps/doc/` to understand the current documentation structure, identify where your new content fits, check for overlapping or related information, and determine if you need to create a new file or update existing ones. The document...

Details

Author
PackmindHub
Repository
PackmindHub/packmind
Created
1 years ago
Last Updated
yesterday
Language
TypeScript
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Listed

docs-create

This skill should be used when creating new documentation files or updating existing ones, especially when documenting system architecture, features, integrations, workflows, or technical decisions. Also use when asked to "document", "write docs for", or "create a doc about" any system component. Trigger this skill whenever the user wants to capture knowledge about how something works, even if they don't explicitly say "documentation" — phrases like "explain how X works and save it", "write up the auth flow", or "I need a reference for the API" all qualify.

0 Updated 2 days ago
devgirishattri
Code & Development Listed

author-product-docs

Create, revise, retrofit, audit, or verify product documentation — pack READMEs, journeys, tutorials, how-to guides, reference pages, and explanations. Use when asked to write, improve, restructure, audit, or verify user-facing documentation, fix a pack README, create a guide for a feature, update a journey page, or check whether docs match shipped behavior. Infers the mode from the request. Do NOT use for feature specifications (use new-spec), cross-cutting proposals (use new-rfc), decisions (use new-adr), product or market strategy, frontend implementation alone, internal maintainer runbooks without user-facing concern, or arbitrary prose editing with no documentation purpose.

24 Updated today
eugenelim
Data & Documents Listed

documentation

Creates, structures, and reviews technical documentation following the Diátaxis framework (tutorials, how-to guides, reference, and explanation pages). Use when a user needs to write or reorganize docs, structure a tutorial vs. a how-to guide, build reference docs or API documentation, create explanation pages, choose between Diátaxis documentation types, or improve existing documentation structure. Trigger terms include: documentation structure, Diátaxis, tutorials vs how-to guides, organize docs, user guide, reference docs, technical writing.

18 Updated yesterday
shortcuts