0034-laravel-documentation-best-practices

What problem does it solve?

It helps teams reduce vague, redundant documentation by teaching authors to document the reasoning behind complex decisions and business logic rather than restating what the code already shows.

Core Features & Use Cases

• Document the why, not the what: Replace obvious or repetitive comments with explanations of intent, constraints, and decision criteria.
• Cover complex business logic deeply: Capture rules, tiers, edge cases, and the impact of related conditions so future readers can safely modify behavior.
• Use self-documenting code techniques: Improve naming, extract methods, apply type declarations, and model domain concepts so documentation complements clarity instead of compensating for it.
• Write effective PHPDoc and API docs: Add structured parameter/return details, deprecation notes, and response/serialization documentation where it reduces ambiguity.

Quick Start

Ask an AI to rewrite your Laravel-related comments and documentation so they focus on the underlying business rules, non-obvious tradeoffs, and external integration constraints, using concise PHPDoc where types and API behavior aren’t self-evident.