47 lines
3.0 KiB
Markdown
47 lines
3.0 KiB
Markdown
---
|
|
name: roa-actualizare-doc
|
|
description: Actualizeaza documentatia si fluxurile dupa o sesiune de lucru - transforma cunostintele noi reutilizabile (flux ascuns, capcana platita, procedura/tabela cheie) in docuri/reguli minimale. Culege ce s-a invatat, filtreaza 80/20 (doar reutilizabil, nu tot ce s-a atins), PROPUNE modificarile si aplica doar dupa aprobarea lui Marius, apoi actualizeaza indexul COMUN\docs\README.md si declansatorul din reguli_lucru.md pct. 7. Foloseste-l OBLIGATORIU la final de sesiune sau de lucrare, cand utilizatorul spune "salveaza ce ai invatat", "actualizeaza docurile/fluxurile", "de ce a durat mult sa gasesti X", sau cand ai descoperit un flux/capcana/obiect cheie nedocumentat. Nu scrie din oficiu - intai propui, apoi aplici.
|
|
---
|
|
|
|
# Actualizarea documentatiei si a fluxurilor dupa o sesiune
|
|
|
|
Formalizeaza regula 11 din `reguli_lucru.md` ("propune actualizarea documentatiei la final").
|
|
Scopul: urmatoarea sesiune gaseste mai repede; nu se pastreaza tot, doar reutilizabilul (80/20).
|
|
|
|
## Pasi
|
|
|
|
1. **Culege** ce s-a invatat in sesiune: flux ascuns, capcana platita, procedura/tabela cheie,
|
|
locul unde sta un obiect greu de gasit.
|
|
2. **Filtreaza 80/20**: doar reutilizabil, nu tot ce s-a atins, nu verbose, fara istoric, fara
|
|
studii de caz, fara "de ce" (cititorul e un agent care stie deja contextul).
|
|
3. **Propune** (nu scrie inca): lista de modificari + destinatia fiecareia (fisier + 2-3 randuri).
|
|
Astepti aprobarea lui Marius.
|
|
4. **Aplica dupa aprobare**, la locul potrivit:
|
|
- comun tuturor produselor -> `COMUN\docs\<subiect>.md`;
|
|
- specific unui produs -> `<PRODUS>\docs\` (in `cercetare\` daca e cercetare incheiata);
|
|
- element comun de cod -> `COMUN\docs\inventar-comun.md`;
|
|
- rutare noua de skill -> `COMUN\skills\<nume>\SKILL.md` + rand in `backstop_skills.txt`.
|
|
5. **Rutare**: adauga randul in indexul `COMUN\docs\README.md` + declansatorul in
|
|
`reguli_lucru.md` pct. 7. Daca e skill nou, ruleaza `leaga_skills.ps1` (symlink) si
|
|
`scrie_backstop_skills.ps1` (AGENTS.md) -> skill `roa-onboarding` pasii 13-14.
|
|
|
|
## Reguli
|
|
|
|
- ASCII, fara diacritice; CRLF la `.sql`. Un subiect = un singur proprietar (ceilalti primesc o
|
|
trimitere de un rand, nu o copie).
|
|
- O notita = regula + strictul de context ca sa fie aplicabila. Nu duplica: verifica intai
|
|
`COMUN\docs\README.md` si `docs\cercetare\` ca subiectul sa nu existe deja.
|
|
- Nu documenta ce se deduce din cod; documenteaza fluxul ascuns, capcana, locul greu de gasit.
|
|
|
|
## Criterii de acceptare si dovada
|
|
|
|
1. Propunerea a fost aprobata de Marius inainte de scriere (nu s-a scris din oficiu).
|
|
2. Fisierele noi sunt ASCII (0 octeti > 127); `.sql` cu CRLF.
|
|
3. Randul din `README.md` si declansatorul din `reguli_lucru.md` pct. 7 au fost adaugate.
|
|
|
|
## Referinta (doar la nevoie)
|
|
|
|
- `COMUN\docs\README.md` - indexul documentatiei comune (tabelul "cand citesti fiecare").
|
|
- `COMUN\docs\reguli_lucru.md` pct. 7 (routing) si pct. 11 (propune actualizarea doc).
|
|
- `COMUN\skills\roa-domeniu-rutare\SKILL.md` - harta surselor (unde sta fiecare obiect/flux).
|