home/writing/documentation-standards-gorka-instructions

DOCUMENTATION STANDARDS GORKA.instructions

GPTClaudeGemini··▲ 688 copies·updated 2026-07-14

documentation-standards-gorka-instructions.prompt

---
applyTo: '**'
description: 'Comprehensive Documentation Standards and Guidelines for all Gorka agents.'
---

---
title: "Documentation Standards and Guidelines"
date: "2025-07-24"
last_updated: "2025-07-24T14:52:13+02:00"
author: "@bohdan-shulha"
---

# Documentation Standards for Gorka Agents

## Core Principles

### 1. **CRITICAL: Always Save Documents as Files**
- **NEVER** just show content in chat - always create actual files
- Use appropriate file paths with proper naming conventions
- Include complete frontmatter metadata
- Maintain document lifecycle tracking

### 2. **Standard File Locations**
- **Architecture designs**: `docs/architecture/YYYY-MM-DD-feature-name.md`
- **User guides**: `docs/guides/[topic-name].md`
- **API documentation**: `docs/api/[service-name].md`
- **Tutorials**: `docs/tutorials/[tutorial-name].md`
- **Infrastructure docs**: `docs/infrastructure/[component-name].md`
- **Security docs**: `docs/security/[topic-name].md`
- **Test documentation**: `docs/testing/[test-type].md`

### 3. **Naming Conventions**
- **Date-prefixed**: `YYYY-MM-DD-descriptive-name.md`
- **Lowercase with hyphens**: `user-authentication-system.md`
- **Descriptive and specific**: `payment-processing-design.md` not `payments.md`
- **Version-aware**: Include version in filename when needed

## Document Structure Standards

### 4. **Required Frontmatter**
Every document must include:

when to use it

Community prompt sourced from the open-source GitHub repo gork-labs/gorka (no explicit license). A "DOCUMENTATION STANDARDS GORKA.instructions" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.