document-a-real-workflow

Structures package documentation as question-driven workflows with minimal setup and interpreted results.

1|Updated Aug 11, 2026
One-click install
npx skills add https://github.com/0xMuluh/package-development-skills --skill document-a-real-workflow-0xmuluh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-a-real-workflow
Source: https://github.com/0xMuluh/package-development-skills/tree/main/document-a-real-workflow
Command: npx skills add https://github.com/0xMuluh/package-development-skills --skill document-a-real-workflow-0xmuluh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Package documentation often becomes a catalog of functions or an exposition of internal architecture, leaving users unable to accomplish real tasks. This Skill guides the creation and revision of vignettes, tutorials, README examples, and migration guides so they teach one realistic workflow from a user question to an interpreted result. ## Core Features & Use Cases - Question-Driven Structure: Organizes documentation as a real user question, minimal setup, a few package operations, a standard result, and interpretation. - API Design Feedback: Treats documentation complexity as a signal of API friction, exposing excessive ceremony rather than hiding it behind vignette-only helpers. - Ecosystem Reuse: Encourages reusing existing containers, preprocessing, and plotting tools instead of recreating neighboring package functionality. - Use Case: When writing a vignette for an R package that performs joint ordination, use this Skill to structure the article around the question "Do two omics layers share structured variation?", starting from a standard MultiAssayExperiment and ending with an interpreted ordination result. ## Quick Start Use the document-a-real-workflow skill to review my package vignette and restructure it around a single real user question with minimal setup and a clear interpretation section.

Frequently Asked Questions about document-a-real-workflow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a good package vignette?▼

Start from a real user question, use a standard data representation, keep setup minimal, apply one or a few package functions, show the native result, and interpret the output. Focus each vignette on a single workflow rather than cataloging all package functions.

How should I structure README examples for a package?▼

README examples should show a standard input object, one meaningful package call, and a familiar result type. Avoid long installation-to-publication workflows so readers quickly understand what the package uniquely contributes.

When should documentation reuse other packages instead of being self-contained?▼

Reuse established packages for preprocessing, normalization, plotting, and import whenever they already solve the problem. Artificial self-containment hides interoperability and duplicates neighboring ecosystem functionality without benefit to users.

What does it mean when a vignette needs many helper functions?▼

Numerous vignette-only helpers signal excessive API ceremony rather than a documentation problem. Consider whether the helpers should become public adapters, use existing ecosystem tools, or disappear through API simplification in a separate change.

How do I write a migration guide for renamed functions?▼

Show the old call and the new call side by side, then state whether analysis behavior is unchanged. Keep the guide focused on the migration itself rather than expanding it into a full method tutorial.