Verified:GitHub

wiki

Create high-level GitLab Wiki system descriptions with Mermaid diagrams.

Updated Mar 7, 2016

Search Tags:#technical documentation #system documentation #engineering communication #GitLab Wiki #whiteboarding sessions

One-click install

npx skills add https://github.com/BarrettLowe/dotfiles --skill wiki-barrettlowe

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: wiki
Source: https://github.com/BarrettLowe/dotfiles/tree/main/claude/skills/wiki
Command: npx skills add https://github.com/BarrettLowe/dotfiles --skill wiki-barrettlowe

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the creation of detailed GitLab wiki content by offering a focused guide for engineers to create high-quality, high-level documentation without the need for implementation specifics.

Core Features & Use Cases

Quick and Systematic Creation: Simplifies the documentation process with a structured outline and prompts.
High-Level Focus: Encourages writing from the perspective of a knowledgeable engineer explaining to another new one, ensuring the content is understandable and useful.
Mermaid Diagrams: Requires at least one Mermaid diagram for visual clarity on complex systems.

Quick Start

Write a GitLab wiki page about the data ingestion pipeline using the '/wiki' command.

Frequently Asked Questions about wiki

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

FAQPage Schema

How do I write high-level system documentation for GitLab Wiki without including implementation details?▼

To write high-level GitLab Wiki system documentation without implementation details, use a structured template that frames the content as an experienced engineer explaining the system context to a new engineer for knowledge sharing and training.

What is the best way to structure engineering knowledge sharing content for a new team member?▼

The best way to structure engineering knowledge sharing content is to provide high-level system explanations and context from the perspective of a knowledgeable engineer, avoiding technical implementation specifics to ensure the documentation is easily understandable.

How do I add Mermaid diagrams to technical documentation in GitLab Wiki?▼

To add Mermaid diagrams to technical documentation in GitLab Wiki, include at least one Mermaid diagram within the page structure to provide visual clarity on complex systems and illustrate data flows or architectures.

Does the wiki generation template require technical implementation specifics for the system explanation?▼

No, the wiki generation template explicitly avoids technical implementation specifics, focusing entirely on high-level system explanations and context to streamline engineering communication and training.

Can I use a whiteboarding session to generate GitLab Wiki content for a data ingestion pipeline?▼

Yes, you can translate whiteboarding session outputs into GitLab Wiki content by using a structured outline and prompts to systematically author high-level system descriptions for pipelines or other complex architectures.

What are the limitations of using automated templates for system documentation in GitLab Wiki?▼

The limitation of using automated templates for system documentation is that they enforce a high-level perspective, meaning they are not suitable for capturing deep technical implementation details or granular code-level specifics.