docs-writing

Write, edit, and review Railway platform documentation following a strict style guide.

293|1.1k|Updated Jan 14, 2021
One-click install
npx skills add https://github.com/railwayapp/docs --skill docs-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writing
Source: https://github.com/railwayapp/docs/tree/main/skills/docs-writing
Command: npx skills add https://github.com/railwayapp/docs --skill docs-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of writing, editing, and reviewing documentation, ensuring clarity, accuracy, and adherence to established style guides.

Core Features & Use Cases

  • Content Creation: Draft new documentation pages following specific content types and structures.
  • Editing & Review: Refine existing content for voice, tone, grammar, and technical accuracy.
  • Style Adherence: Ensure all documentation complies with Railway's specific style guide, terminology, and formatting rules.
  • Use Case: You need to write a new guide on deploying a Node.js application, ensuring it follows the established structure, voice, and includes all necessary code examples and component references.

Quick Start

Write a new guide for deploying a Python Flask application, following the standard deployment guide structure and using the specified voice and tone.

Frequently Asked Questions about docs-writing

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

FAQPage Schema
How do I write technical documentation that follows a strict style guide?

To write technical documentation adhering to a strict style guide, draft your content using structured templates that enforce consistent terminology, formatting, and voice. This ensures all new pages maintain uniform technical accuracy and clarity across the platform.

What is the best way to edit existing markdown documentation for clarity and accuracy?

Editing existing markdown documentation for clarity and accuracy involves reviewing prose against established style rules, refining technical terminology, and correcting grammar. This process refines the content to ensure it meets voice and tone standards while remaining technically precise.

Can I use this to draft new product guides with code examples and component references?

Yes, you can draft new product guides that integrate code examples and component references. The process structures your deployment guide content to include all necessary technical elements while maintaining the specified voice and formatting rules.

How do I ensure consistent terminology and formatting across all my content creation?

Ensuring consistent terminology and formatting across content creation requires applying a standardized style guide during the writing and review phases. This enforces uniform language usage and document structure across all technical documentation.

What are the limitations of relying on a standardized style guide for technical writing?

Relying on a standardized style guide for technical writing limits flexibility in voice and structural formatting. Documentation must strictly conform to predefined terminology and content structures, which may restrict creative or alternative presentation styles.