skills.rest
specklesystems
specklesystemsOFFICIAL
Explore all skills by this author →
Website𝕏@specklesystemsGitHub

document-dev-speckle-feature

Document new Speckle Server features through codebase analysis and page planning.

2|1|Updated May 3, 2025
Search Tags:#documentation#screenshot#mdx#docs-automation#code-exploration#feature-docs#speckle
One-click install
npx skills add https://github.com/specklesystems/speckle-docs-NEW --skill document-dev-speckle-feature
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-dev-speckle-feature
Source: https://github.com/specklesystems/speckle-docs-NEW/tree/main/.universal-ai-config/skills/document-dev-speckle-feature
Command: npx skills add https://github.com/specklesystems/speckle-docs-NEW --skill document-dev-speckle-feature

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams create comprehensive documentation for new Speckle Server features by guiding codebase exploration, screenshot planning, and page placement.

Core Features & Use Cases

  • Guided feature exploration of a local Speckle Server deployment to surface architecture, UI entry points, and usage scenarios.
  • Automated planning for documentation pages, including placement in docs.json and cross-linking to related pages.
  • Screenshot strategy and artifact management for doc pages, including placeholder guidance when automatic capture is not available.

Quick Start

Run the feature documentation workflow against a local speckle-server repo and follow the prompts to choose doc placement and generate page drafts.

Frequently Asked Questions about document-dev-speckle-feature

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

FAQPage Schema
How do I document a new Speckle Server feature from codebase to published page?▼

To document a Speckle feature, you explore the local server codebase to surface architecture and UI entry points, plan a screenshot strategy, determine page placement in docs.json, and generate MDX page drafts for the documentation structure.

How do I plan screenshots and manage artifacts for feature documentation?▼

Planning screenshots for feature documentation requires a defined strategy that outlines necessary UI interactions and provides placeholder guidance for artifact management when automatic screenshot capture is unavailable.

Do I need a local Speckle Server deployment to generate feature docs?▼

Yes, you need a local speckle-server repository deployment to run the feature documentation workflow, which analyzes the codebase to surface architecture, API interactions, and UI usage scenarios for the new feature.

How does documentation automation handle page placement and cross-linking?▼

Documentation automation handles page placement by determining where new pages belong within the existing docs.json structure and automatically generating cross-links to related documentation pages.

What is the best way to explore a codebase for new feature documentation?▼

The best way to explore a codebase for feature documentation is through a guided workflow that surfaces architecture, UI entry points, and usage scenarios specific to the newly developed Speckle feature.

Related Skills

Explore More Software Engineering Skills→
specklesystemsspecklesystems
2

open-dev-speckle-in-browser

Launch a local Speckle development environment in a browser for UI exploration and screenshots.

Official
Advanced
ophidiariumophidiarium
5

mintlify

Build Mintlify documentation sites by authoring MDX pages and configuring docs.json navigation.

Official
Intermediate
tercumantanumuttercumantanumut
167

playwright

Automate browser interactions via Playwright CLI for testing and data extraction.

Community
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate