skills.rest
cameronraysmith
cameronraysmithCOMMUNITY
Explore all skills by this author →
Website𝕏@cameronraysmithGitHub

preferences-documentation

Define Diátaxis-based user and AMDiRE-based development documentation conventions.

14|Updated May 28, 2024
Search Tags:#documentation#maintenance#structure#standards#traceability#Diataxis#AMDiRE
One-click install
npx skills add https://github.com/cameronraysmith/vanixiets --skill preferences-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: preferences-documentation
Source: https://github.com/cameronraysmith/vanixiets/tree/main/modules/home/ai/skills/src/core/preferences-documentation
Command: npx skills add https://github.com/cameronraysmith/vanixiets --skill preferences-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses inconsistencies and inefficiencies in documentation by providing clear guidelines on structure, formatting, and maintenance, ensuring documentation is discoverable, understandable, and maintainable.

Core Features & Use Cases

  • Standardized Structure: Implements a recommended directory structure for user-facing and development documentation, inspired by Diátaxis and AMDiRE methodologies.
  • Lifecycle Management: Defines practices for managing working notes and formal documentation, including provenance tracking and conflict resolution.
  • Use Case: When starting a new project, use this Skill to set up the docs/ directory with the recommended structure and to guide the writing of initial documentation artifacts like context and requirements specifications.

Quick Start

Use the preferences-documentation skill to review the recommended documentation structure for a new project.

Frequently Asked Questions about preferences-documentation

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

FAQPage Schema
How do I structure documentation for a new software project?▼

Structure documentation by implementing Diátaxis for user docs and AMDiRE for development docs, ensuring artifacts are discoverable and maintainable.

What is the Diátaxis framework for documentation?▼

Diátaxis is a documentation methodology categorizing content into tutorials, how-to guides, reference, and explanation, used here to standardize user-facing documentation structure.

How do I track provenance and lifecycle for working notes?▼

Track provenance and lifecycle by defining practices for managing working notes and formal documentation, including provenance tracking and conflict resolution throughout the artifact lifecycle.

What's the best way to maintain consistency across development documentation?▼

Maintain consistency by applying AMDiRE-based development documentation standards, enforcing provenance tracking and lifecycle management for all documentation artifacts across the project.

Do I need any specific dependencies to set up standardized documentation conventions?▼

No dependencies are required to set up standardized documentation conventions; the skill provides structure, formatting, and maintenance guidelines directly applicable to a new project's docs directory.

Related Skills

Explore More Software Engineering Skills→
asermaxasermax
1

init-framework

Initialize katachi framework directories and CLAUDE.md baseline in projects.

Community
Intermediate
tyrchentyrchen
50

spec

Generate dependency-ordered Markdown specifications from feature ideas.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
CygnusfearCygnusfear
5

obsidian-plan-wiki

Create modular Obsidian-compatible markdown wikis for project plans.

Community
Advanced