Documentation best practices
Skill soden46/syarif-laravel-ai-skills/skills/documentation-best-practices
Laravel guidance to write meaningful documentation that explains why not what; focus on complex business logic and self-documenting codeFrom its SKILL.md
npx -y skills add soden46/syarif-laravel-ai-skills --skill documentation-best-practicesAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 4 stars4 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
2.0 KB, 347 tokens by cl100k_base, as published. Nobody here has run it
Documentation Best Practices
Use this skill when a Laravel task involves documentation best practices.
This skill is adapted to the personal Laravel standards in this repository. It maps the public documentation-best-practices topic from jpcaparas/superpowers-laravel into the local documentation-best-practices catalog without copying third-party skill body text.
Syarif Defaults
- Follow Laravel conventions before introducing custom abstractions.
- Prefer project-local patterns when they are explicit and tested.
- Keep controllers focused on HTTP orchestration.
- Put validation, authorization, transactions, side effects, and integrations at clear boundaries.
- Keep client names, credentials, internal URLs, provider secrets, and project-specific business rules out of reusable standards.
- Verify important behavior with the smallest meaningful tests and quality checks.
Workflow
- Detect the Laravel version, PHP version, runner, package manager, and existing project conventions.
- Identify the smallest local skill set that overlaps this topic.
- Implement or review the change using Laravel-native APIs first.
- Add abstractions only when they reduce real complexity or protect a meaningful boundary.
- Run targeted tests and available quality checks before handoff.
Checkpoints
- Authorization and validation boundaries are explicit.
- Query shape, transactions, queues, cache, files, and external calls are intentional when touched.
- User-facing behavior has feature, unit, browser, or integration tests at the right level.
- Logs and errors are useful without exposing secrets or unnecessary personal data.
- Documentation or proposals avoid importing source-project names or one-off business rules.
Related Skills
using-laravel-standardsarchitecturetestingsecurity
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.
Gives 0 of the 12 instructions most docs writing skills give in 347 tokens
Counted across 1,951 of the 3,904 authors here whose files we hold, read 2026-09-06
- Use third-person for skill descriptionsin 54 of 1951, across 35 files
- Start descriptions with Use whenin 43 of 1951, across 29 files
- Run baseline scenarios before writing any skillin 40 of 1951, across 26 files
- Use active voicein 40 of 1951, across 36 files
- Map file responsibilities before defining tasksin 36 of 1951, across 29 files
- Use checkbox syntax for tracking stepsin 35 of 1951, across 27 files
- Ask one question at a timein 35 of 1951
- Offer execution options after saving the planin 33 of 1951, across 24 files
- Include complete code in every stepin 33 of 1951, across 27 files
- Design units with clear boundaries and interfacesin 31 of 1951, across 23 files
- Announce the skill usage at the startin 30 of 1951
- Verify agent compliance after adding the skillin 29 of 1951, across 17 files
Said here and by no other author read
- Focus documentation on complex business logic
- Follow Laravel conventions before using custom abstractions
- Keep controllers focused on HTTP orchestration
- Verify behavior with smallest meaningful tests
- Use Laravel native APIs first
- Add abstractions only to reduce real complexity
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.