skills.rest
giantswarm
giantswarmOFFICIAL
Explore all skills by this author →
WebsiteGitHub

write-observability-docs

Automate creation and editing of Giant Swarm observability documentation pages.

7|7|Updated Feb 2, 2015
Search Tags:#documentation#style guide#observability#content creation#Giant Swarm
One-click install
npx skills add https://github.com/giantswarm/docs --skill write-observability-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-observability-docs
Source: https://github.com/giantswarm/docs/tree/main/.claude/skills/write-observability-docs
Command: npx skills add https://github.com/giantswarm/docs --skill write-observability-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

The manual process of writing and updating observability documentation for Giant Swarm can be time-consuming and error-prone. This Skill simplifies the creation and editing of documentation, ensuring consistency and efficiency.

Core Features & Use Cases

  • Streamlined Documentation: Automates the creation of documentation pages, reducing manual effort.
  • Content Consistency: Ensures that all documentation follows the Giant Swarm style guide and internal structure.
  • Quick Start: With a file path or topic, quickly create or edit a documentation page.

Quick Start

To create a new page on observability, use the write-observability-docs skill with the argument "new-topic".

Frequently Asked Questions about write-observability-docs

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

FAQPage Schema
How do I create observability documentation for Giant Swarm?▼

To create observability documentation for Giant Swarm, use the write-observability-docs skill with a file path or topic argument to automate page creation and ensure adherence to the internal style guide.

What is the best way to ensure my documentation follows the Giant Swarm style guide?▼

The best way to ensure adherence to the Giant Swarm style guide is to use the write-observability-docs skill, which automatically enforces internal structure and consistency during the content creation and editing process.

How does Diátaxis classification work when structuring technical documentation?▼

Diátaxis classification categorizes documentation into tutorials, how-to guides, references, and explanations. The write-observability-docs skill applies this framework to place observability content correctly within the documentation hierarchy.

Can I edit an existing observability documentation page by providing a file path?▼

Yes, you can edit an existing observability documentation page by providing the file path to the write-observability-docs skill, which streamlines updates while maintaining the required internal structure and style.

Do I need reference resources to automate observability content creation?▼

You need reference resources to automate observability content creation. The write-observability-docs skill handles these resources to correctly position and format the documentation within the Giant Swarm hierarchy.

Related Skills

Explore More Content & Communication Skills→
gaabscpsgaabscps
1

observe

Initialize a session.yml state file with schema and trail vocabulary.

Community
Basic
bordenetbordenet
8

link-verification

Validate and verify Markdown links in documentation before publishing.

Community
Advanced
Enso-SoftEnso-Soft
1

android-conventions

Standardize Android/Kotlin naming, patterns, and code style conventions.

Community
Basic
foeriafoeria

格式转换助手

Convert Markdown files into Word-ready documents with preserved structure.

Community
Basic