gitlab-docs

Solid

Draft, rewrite, or audit concise product and engineering documentation using an independently expressed interpretation of the GitLab documentation style. Use for product guides, configuration, administration, tutorials, troubleshooting, contributor docs, and technical pages that must be searchable, precise, and localization-friendly.

Code & Development 60 stars 2 forks Updated 2 weeks ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
59
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# GitLab docs Create brief, direct product documentation that functions as a trustworthy source of truth. ## Preserve technical truth - Keep commands, code, product names, UI labels, versions, defaults, and results exact. - Do not convert an implementation detail into a product promise. - Separate confirmed behavior from a workaround, hypothesis, or planned behavior. - Ask for missing availability, permission, or version facts instead of inventing them. ## Choose a topic type Select one primary purpose per topic: - Concept: explain what something is, why it matters, and how parts relate. - Task: help the reader achieve one outcome through ordered actions. - Reference: present fields, options, syntax, or limits in a predictable structure. - Troubleshooting: connect a symptom to checks, causes, and recoveries. Split a page when these purposes compete. A short context paragraph may introduce a task, but do not bury the first action under a conceptual essay. ## Write from the customer's perspective - Lead with what the reader can accomplish or needs to know. - Address the reader as `you` for user actions. Name GitLab or another component when the product performs the action. - Prefer active voice, but use passive voice when the actor is irrelevant and the result is clearer. - Use concise, conversational sentences without chatty asides. - Keep one term for each feature. Match the product's visible labels and casing. - State facts and achievable outcomes. Qualify perfo...

Details

Author
Neeeophytee
Repository
Neeeophytee/agent-stylebooks
Created
3 weeks ago
Last Updated
2 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

Code & Development Solid

github-docs

Draft, rewrite, or audit approachable developer product documentation using an independently expressed interpretation of the GitHub Docs style. Use for product workflows, how-to guides, conceptual overviews, troubleshooting, security guidance, and documentation that should move developers from prerequisites to a verified outcome.

60 Updated 2 weeks ago
Neeeophytee
Code & Development Listed

author-product-docs

Create, revise, retrofit, audit, or verify product documentation — pack READMEs, journeys, tutorials, how-to guides, reference pages, and explanations. Use when asked to write, improve, restructure, audit, or verify user-facing documentation, fix a pack README, create a guide for a feature, update a journey page, or check whether docs match shipped behavior. Infers the mode from the request. Do NOT use for feature specifications (use new-spec), cross-cutting proposals (use new-rfc), decisions (use new-adr), product or market strategy, frontend implementation alone, internal maintainer runbooks without user-facing concern, or arbitrary prose editing with no documentation purpose.

21 Updated today
eugenelim
Code & Development Solid

google-developer-docs

Draft, rewrite, or audit developer documentation using an independently expressed interpretation of the Google developer documentation style. Use for API guides, tutorials, concepts, setup instructions, code explanations, command-line documentation, and technical content for a global developer audience.

60 Updated 2 weeks ago
Neeeophytee