PHPackages                             alessandrocampos224/laravel-feature-docs - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. alessandrocampos224/laravel-feature-docs

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

alessandrocampos224/laravel-feature-docs
========================================

Generate technical and functional documentation from git diff changes in Laravel projects.

v1.0.0(3mo ago)01↓83.3%MITPHPPHP ^8.2CI passing

Since Mar 21Pushed 3mo agoCompare

[ Source](https://github.com/alessandrocampos224/laravel-feature-docs)[ Packagist](https://packagist.org/packages/alessandrocampos224/laravel-feature-docs)[ Docs](https://github.com/alessandrocampos224/laravel-feature-docs)[ RSS](/packages/alessandrocampos224-laravel-feature-docs/feed)WikiDiscussions main Synced 3w ago

READMEChangelogDependencies (9)Versions (2)Used By (0)

alessandrocampos224/laravel-feature-docs
========================================

[](#alessandrocampos224laravel-feature-docs)

Package Laravel para gerar documentação técnica e funcional a partir de mudanças reais do código via `git diff`.

O que o package entrega
-----------------------

[](#o-que-o-package-entrega)

- Comando Artisan `docs:update-from-diff`
- Pipeline desacoplado por contratos (diff, classificação, contexto, IA, geração, escrita)
- Dois documentos Markdown por feature:
- `docs/technical/.md`
- `docs/client/.md`
- Metadata rastreável em JSON:
- `docs/.meta/.json`
- Atualização seletiva de docs existentes com prompt dedicado
- Config publicável e implementações sobrescrevíveis via container

Instalação
----------

[](#instalação)

```
composer require alessandrocampos224/laravel-feature-docs
```

Publique config e prompts:

```
php artisan vendor:publish --tag=feature-docs-config
php artisan vendor:publish --tag=feature-docs-prompts
```

Configuração
------------

[](#configuração)

Arquivo `config/feature-docs.php` contém os grupos:

- `git`
- `paths`
- `features`
- `ai`
- `generation`

Provider de IA default no v1: `openai` (obrigatório configurar chave).

Variáveis principais:

- `FEATURE_DOCS_AI_PROVIDER=openai`
- `FEATURE_DOCS_AI_MODEL=gpt-5`
- `FEATURE_DOCS_OPENAI_API_KEY=...`
- `FEATURE_DOCS_OPENAI_BASE_URL=https://api.openai.com/v1`

Comando principal
-----------------

[](#comando-principal)

```
php artisan docs:update-from-diff
php artisan docs:update-from-diff --base=origin/main --head=HEAD
php artisan docs:update-from-diff --stage=staged
php artisan docs:update-from-diff --files="app/Services/ProductService.php,routes/web.php"
php artisan docs:update-from-diff --feature=produtos/preco-promocional
php artisan docs:update-from-diff --only=technical
php artisan docs:update-from-diff --format=json
php artisan docs:update-from-diff --dry-run
```

Assinatura:

```
protected $signature = 'docs:update-from-diff
    {--base= : Git base reference}
    {--head=HEAD : Git head reference}
    {--stage= : unstaged|staged|all}
    {--feature= : Force feature slug}
    {--files= : Comma separated list of files}
    {--only= : technical|client|all}
    {--format=markdown : markdown|json}
    {--dry-run : Preview without writing files}';
```

Pipeline implementado
---------------------

[](#pipeline-implementado)

1. Descobre escopo de comparação
2. Lê diff do Git
3. Converte alterações em DTOs
4. Classifica impacto por heurística
5. Resolve `feature_slug`
6. Monta contexto consolidado
7. Carrega prompts versionados do disco
8. Gera docs técnica e cliente via IA
9. Atualiza docs existentes quando houver
10. Salva Markdown e metadata JSON
11. Retorna resumo no console (`markdown` ou `json`)

Contratos públicos
------------------

[](#contratos-públicos)

- `DiffReader`
- `ChangeClassifier`
- `FeatureResolver`
- `ContextBuilder`
- `PromptRepository`
- `AiClient`
- `DocGenerator`
- `DocWriter`

Todos podem ser sobrescritos com `bind` no container do Laravel.

Estrutura de prompts
--------------------

[](#estrutura-de-prompts)

PromptRepository suporta nomes canônicos e fallback para variantes com acento.

Arquivos esperados:

- `prompt-base.md`
- `prompt-de-classificacao-de-mudanca.md` (fallback para `prompt-de-classificação-de-mudança.md`)
- `prompt-de-doc-tecnica.md`
- `prompt-de-doc-cliente.md`
- `prompt-de-atualizacao-de-doc-existente.md` (fallback para `prompt-de-atualização-de-doc-existente.md`)

Testes
------

[](#testes)

Stack:

- Pest
- Orchestra Testbench

Rodar:

```
composer test
```

Cobertura base:

- leitura de diff
- classificação heurística
- resolução de feature
- carregamento de prompts
- geração de paths e escrita
- dry-run
- criação de docs novas
- atualização de docs existentes

Compatibilidade
---------------

[](#compatibilidade)

- Laravel 10, 11, 12 e 13
- PHP 8.2+

Extensão futura
---------------

[](#extensão-futura)

O núcleo não depende de Filament. Um plugin Filament pode ser criado depois para exibição e busca visual das docs geradas.

###  Health Score

35

—

LowBetter than 77% of packages

Maintenance81

Actively maintained with recent releases

Popularity1

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

98d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/10c0ba71c91926e58249998fffccfda512db5dba64b19196ea25a4526be5e5eb?d=identicon)[alessandrocampos224](/maintainers/alessandrocampos224)

---

Top Contributors

[![alessandrocampos224](https://avatars.githubusercontent.com/u/68436185?v=4)](https://github.com/alessandrocampos224 "alessandrocampos224 (2 commits)")

---

Tags

laravelautomationdocumentationopenaigit diff

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/alessandrocampos224-laravel-feature-docs/health.svg)

```
[![Health](https://phpackages.com/badges/alessandrocampos224-laravel-feature-docs/health.svg)](https://phpackages.com/packages/alessandrocampos224-laravel-feature-docs)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3345.1M337](/packages/psalm-plugin-laravel)[larastan/larastan

Larastan - Discover bugs in your code without running it. A phpstan/phpstan extension for Laravel

6.4k51.0M7.6k](/packages/larastan-larastan)[spatie/laravel-export

Create a static site bundle from a Laravel app

672139.5k6](/packages/spatie-laravel-export)[laravel/mcp

Rapidly build MCP servers for your Laravel applications.

76518.2M120](/packages/laravel-mcp)[spatie/laravel-health

Monitor the health of a Laravel application

87411.3M153](/packages/spatie-laravel-health)[laravel/ai

The official AI SDK for Laravel.

9782.1M162](/packages/laravel-ai)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
