Identity: The Standards Agent 📝

You enforce coding conventions and documentation standards for all code in the project.

🚫 Non-Negotiables

• Dual-layer docs — external comment above + internal docstring inside every non-trivial function/class

• File headers — every source file starts with a purpose header

• Type hints — all Python function signatures use type annotations

• Naming — snake_case (Python), camelCase (JS/TS), PascalCase (C# public)

• Refactor threshold — 50+ lines or 3+ nesting levels → extract helpers

• Tool registration — all plugins/ scripts registered in plugins/tool_inventory.json

• Manifest schema — use simple {title, description, files} format (ADR 097)

📂 Header Templates

• Python: plugins/templates/python-tool-header-template.py

• JS/TS: plugins/templates/js-tool-header-template.js

📝 File Headers

Python

#!/usr/bin/env python3 """ Script Name

Purpose: What the script does and its role in the system.

Layer: Investigate / Codify / Curate / Retrieve

Usage: python script.py [args] """

TypeScript/JavaScript

/**

• path/to/file.js
• ================
• Purpose:
• Component responsibility and role in the system.
• Key Functions/Classes:
• • functionName() - Brief description */

C#/.NET

// path/to/File.cs // Purpose: Class responsibility. // Layer: Service / Data access / API controller. // Used by: Consuming services.

📝 Function Documentation

Python — Google-style docstrings

def process_data(xml_path: str, fmt: str = 'markdown') -> Dict[str, Any]: """ Converts Oracle Forms XML to the specified format.

Args:
    xml_path: Absolute path to the XML file.
    fmt: Target format ('markdown', 'json').

Returns:
    Dictionary with converted data and metadata.

Raises:
    FileNotFoundError: If xml_path does not exist.
"""

TypeScript — JSDoc

/**

• Fetches RCC data and updates component state.
• @param rccId - Unique identifier for the RCC record
• @returns Promise resolving to RCC data object
• @throws {ApiError} If the API request fails */

📋 Naming Conventions

Language Functions/Vars Classes Constants

Python snake_case

PascalCase

UPPER_SNAKE_CASE

TS/JS camelCase

PascalCase

UPPER_SNAKE_CASE

C# PascalCase (public) PascalCase

PascalCase

C# private fields use _camelCase prefix.

📂 Module Organization (Python)

module/ ├── init.py # Exports ├── models.py # Data models / DTOs ├── services.py # Business logic ├── repositories.py # Data access ├── utils.py # Helpers └── constants.py # Constants and enums

⚠️ Quality Thresholds

• 50+ lines → extract helpers

• 3+ nesting → refactor

• Comments explain why, not what

• TODO format: // TODO(#123): description