write-docs

Write and review LPTS documentation using Snowflake and DuckDB style guidelines.

8|1|Updated Mar 4, 2026
One-click install
npx skills add https://github.com/cwida/lpts --skill write-docs-cwida
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/cwida/lpts/tree/main/.claude/skills/write-docs
Command: npx skills add https://github.com/cwida/lpts --skill write-docs-cwida

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates inconsistent, unstructured LPTS documentation that fails to balance clear reference structure with practical, example-driven guidance for users of the DuckDB extension.

Core Features & Use Cases

  • Standardized Writing Principles: Enforces example-first structure, concise 15-25 word sentences, active voice, and precise behavioral language to eliminate ambiguity in all LPTS documentation.
  • Consistent Page Templates: Provides pre-defined structures for conceptual user guides and SQL reference pages to ensure uniform organization across all project documentation.
  • Formatting & Review Guidelines: Defines rules for syntax blocks, code examples, callout boxes, tables, and limitations sections, plus a pre-publish checklist to catch inconsistencies before release.
  • Use Case: Use this Skill when creating new LPTS documentation, editing existing README or guide pages, or reviewing docs to ensure they align with the project's blended Snowflake/DuckDB style.

Quick Start

Use the write-docs skill to draft a new SQL reference page for the PRAGMA lpts command following the official LPTS documentation style guide.

Frequently Asked Questions about write-docs

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

FAQPage Schema
How do I write technical documentation for a DuckDB extension that balances reference structure with examples?

To write DuckDB extension documentation, apply a blended style that combines Snowflake's structured clarity with DuckDB's example-first approach, enforcing concise 15-25 word sentences and active voice to eliminate ambiguity.

What is the best way to structure a SQL reference page for consistent user guides?

The best way to structure SQL reference pages is using pre-defined templates that enforce uniform organization, precise behavioral language, and standardized formatting rules for syntax blocks and code examples.

How do I review existing README content for style guide compliance before publishing?

Review existing README content by applying a pre-publish validation checklist that checks for consistent page structure, uniform formatting rules, and precise behavioral language to ensure documentation is clear and usable.

Does the LPTS documentation style work for both conceptual guides and SQL reference pages?

Yes, the LPTS documentation style provides pre-defined structures for both conceptual user guides and SQL reference pages, ensuring uniform organization across all project documentation workflows.

What formatting rules should I follow when drafting technical user guides?

When drafting technical user guides, follow formatting rules that define syntax blocks, code examples, callout boxes, tables, and limitations sections, plus enforce 15-25 word sentences and active voice.

Why does my LPTS documentation fail to provide clear guidance for end users?

LPTS documentation fails to provide clear guidance when it lacks a standardized writing style, suffers from inconsistent page structure, or uses ambiguous language instead of precise behavioral descriptions.