docs-writer

Document authoring, review, and improvement processes for SkiaSharp.Extended documentation.

263|75|Updated Jun 5, 2017

Search Tags:#documentation #writing #screenshots #docs #guidelines #maui #docfx

Ready to run

npx skills add https://github.com/mono/SkiaSharp.Extended --skill docs-writer-mono

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/mono/SkiaSharp.Extended/tree/main/.github/skills/docs-writer
Command: npx skills add https://github.com/mono/SkiaSharp.Extended --skill docs-writer-mono

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing and maintaining high-quality documentation for SkiaSharp.Extended is essential to help users learn features, contribute improvements, and adopt best practices.

Core Features & Use Cases

Documentation principles, style guidelines, and best practices for API references, tutorials, and design notes.
Guidance on creating code samples, visuals, and cross-references to external resources.
Processes for writing, reviewing, and updating docs to enhance discoverability and consistency across projects.

Quick Start

Draft a new documentation page by outlining the problem, structuring sections, and including a concise code example.

Frequently Asked Questions about docs-writer

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

FAQPage Schema

How do I structure documentation for MAUI integration and API references?▼

Structure MAUI integration and API reference documentation by outlining the problem, organizing sections with actionable templates, and including concise code samples. Enforce frontmatter presence and structured page layout to ensure consistency and accessibility across all guides.

What are the best practices for writing SkiaSharp.Extended documentation?▼

Best practices for writing SkiaSharp.Extended documentation involve following style guidelines, creating clear code samples with visuals, and applying structured page layouts. Use actionable templates and cross-references to external resources to enhance discoverability and consistency.

How do I review and update existing documentation pages?▼

Review and update existing documentation pages by checking frontmatter presence, verifying structured page layout, and ensuring actionable templates are applied. Validate code samples, visuals, and cross-references to maintain consistency across API references and guides.

Does this documentation approach work for DocFX generated content?▼

Yes, this documentation approach works for DocFX generated content by enforcing frontmatter presence and structured page layout. It applies to creating new docs, updating existing pages, and reviewing contributions across API references, guides, and MAUI integration content.

What should I include in code samples and visuals for technical guidelines?▼

Include concise code examples, clear visuals, and cross-references to external resources in technical guidelines. Apply actionable templates to ensure code samples and visuals are consistent, accessible, and aligned with documentation principles and style guidelines.

Why does my documentation fail consistency checks during review?▼

Documentation fails consistency checks during review when frontmatter is missing, page layout is unstructured, or actionable templates are not applied. Ensure code samples, visuals, and cross-references follow style guidelines to pass review for API references and guides.