Technical Writing

OrtawritingEn az 32K bağlam

Transforms complex technical concepts into clear, well-structured documentation for different audiences. Produces README files, architecture decision records (ADRs), runbooks, onboarding guides, and technical blog posts. Follows documentation best practices with consistent tone, proper formatting, and useful examples.

documentationreadmeadrtechnical-blogonboardingdeveloper-experience

Kullanım alanları

  • Writing a comprehensive README for an open-source project
  • Creating Architecture Decision Records for design choices
  • Producing runbooks for incident response procedures
  • Writing onboarding guides for new team members
  • Drafting technical blog posts explaining complex systems

Örnek prompt

Write an Architecture Decision Record (ADR) for the following decision:

Context: Our API currently uses REST with JSON. We're considering adding GraphQL
for our mobile clients that need flexible queries and reduced over-fetching.

Write the ADR covering:
- Title and status
- Context and problem statement
- Decision drivers
- Considered options (REST-only, GraphQL-only, hybrid)
- Decision outcome with justification
- Consequences (positive, negative, neutral)
- Follow-up actions

Önerilen modeller

claude-opus-4-7gpt-5-5-proclaude-sonnet-4-6gemini-3-1-pro

Uyumlu araçlar

claude-codecursorkiroany

Modaliteler

Giriş: text, code
→
Çıkış: text

İlgili Skills

documentation-generatoremail-writerresearch-summarizer

Yazar

OpenModels Community

@openmodelsrun