trail-sense-user-guides

Create or update Trail Sense tool user guides with standardized YAML frontmatter templates.

2.8k|166|Updated Oct 14, 2019
One-click install
npx skills add https://github.com/kylecorry31/Trail-Sense --skill trail-sense-user-guides
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: trail-sense-user-guides
Source: https://github.com/kylecorry31/Trail-Sense/tree/main/.claude/skills/trail-sense-user-guides
Command: npx skills add https://github.com/kylecorry31/Trail-Sense --skill trail-sense-user-guides

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Trail Sense tools require clear, consistent user guides to help users understand features and usage. This Skill provides a standardized template and best practices for creating or updating tool guides, ensuring uniform structure and language.

Core Features & Use Cases

  • Standardized templates with a YAML frontmatter and a guide body stored at guides/en-US/guide_tool_<toolname>.txt.
  • File Location & Structure guidance: guides how to locate and structure guides, including File Location and Structure sections.
  • Update workflows: helps you write and revise guides when features change or new tools are added.
  • Use Case: imagine a new Trail Sense tool "Compass" added; you can generate a guide named guide_tool_compass.txt with consistent sections, terminology, and styling.

Quick Start

  1. Identify the tool directory under app/src/main/java/com/kylecorry/trail_sense/tools/.
  2. Create or open guides/en-US/guide_tool_<toolname>.txt.
  3. Fill the guide body with sections following the provided structure: File Location, Structure, etc.

Frequently Asked Questions about trail-sense-user-guides

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

FAQPage Schema
How do I write user guides for Trail Sense tools?▼

To write Trail Sense user guides, create a text file at guides/en-US/guide_tool_<toolname>.txt using a standardized template with YAML frontmatter and a structured body to ensure consistent documentation across tools.

What structure should Trail Sense tool documentation follow?▼

Trail Sense tool documentation should follow a standardized guide template containing YAML frontmatter and a body with specific sections like File Location and Structure to maintain uniform language and formatting.

How do I update existing Trail Sense tool guides when features change?▼

Update existing Trail Sense tool guides by opening the guide_tool_<toolname>.txt file in the guides/en-US/ directory and revising the body sections to reflect the new feature changes or tool additions.

Where should Trail Sense user guide files be stored?▼

Trail Sense user guide files should be stored at guides/en-US/guide_tool_<toolname>.txt, corresponding to the tool directory located under app/src/main/java/com/kylecorry/trail_sense/tools/.

What formatting conventions are used for Trail Sense documentation?▼

Trail Sense documentation uses formatting conventions defined by a standardized template, requiring YAML frontmatter and a structured text body to ensure uniform terminology, styling, and section organization.

Do I need YAML frontmatter for Trail Sense guide files?▼

Yes, YAML frontmatter is required for Trail Sense guide files as part of the standardized template, ensuring metadata consistency and proper documentation structure across all tool guides.