romfast/comun
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adauga template prompt pentru conventia docs/ (insight-uri de proiect)

Browse Source 
Reutilizabil in orice proiect ROA* pentru a initializa docs/ + sectiunea
"Project insights" din CLAUDE.md, dupa modelul aplicat in ROAIMOB.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
Marius Mutu
2026-07-08 19:47:36 +03:00
parent e2a06c9054
commit 2e448f0384
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/prompt_project_insights_docs.md Normal file
View File

@@ -0,0 +1,19 @@
# Prompt: seteaza conventia docs/ (insight-uri de proiect) intr-un proiect ROA
Template partajat intre proiectele ROA* (similar cu `changelog_template.txt`). Origine: ROAIMOB, 08/07/2026. Copiaza blocul de mai jos (adaptat, daca e nevoie) intr-o sesiune Claude Code din radacina oricarui proiect ROA* pentru a initializa aceeasi conventie.
---
In acest proiect vreau sa creezi un director `docs/` cu documentatie tehnica concisa, minimalista, descoperita in timp ce lucrezi la sarcini reale (nu documentatie generica, nu ce e deja evident din cod).
Cerinte:
1. Creeaza `docs/README.md` — index cu lista fisierelor din `docs/` si o regula scurta: se adauga/actualizeaza o notita ori de cate ori descoperi ceva nou si ne-evident despre structura proiectului (flux ascuns, capcana, conventie, procedura/pachet cheie, tabel relevant) in timpul rezolvarii unei sarcini. Nu re-documenta ce oricine ar afla citind codul in 30 de secunde.
2. Organizeaza notitele in fisiere separate pe subiect, nu un singur fisier uriaș — ex: `flux-<nume-flux>.md`, `pachet-<nume-pachet>.md`, `tabele.md`.
3. In `CLAUDE.md` (la final), adauga o sectiune "Project insights (docs/)" care:
- trimite spre `docs/README.md`
- imi cere sa iti ofer proactiv actualizarea `docs/` ori de cate ori descoperi un insight ne-evident, fara sa astept sa fiu intrebat
4. Daca `docs/` sau o sectiune similara in `CLAUDE.md` exista deja, nu duplica — extinde ce exista.
5. Nu inventa continut acum daca nu am rezolvat inca o problema concreta in acest proiect — doar pregateste structura (README + sectiunea din CLAUDE.md). Prima notita de continut se scrie cand rezolvam ceva impreuna.
Intreaba-ma doar daca trebuie sa alegi intre variante (ex. denumirea directorului); altfel foloseste `docs/` ca implicit.