Skip to content

Commit d48f039

Browse files
committed
doc - add section: in-code documentation | minor update
version: 1.1.0
1 parent e9d3e27 commit d48f039

File tree

3 files changed

+45
-3
lines changed

3 files changed

+45
-3
lines changed

EN/advanced_code_protocol.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Template for efficient code generation, structured queries, and advanced modific
1010

1111
## Index
1212

13+
- [In-Code Documentation Template](#In-Code-Documentation-Template)
1314
- [Debugging Template](#Debugging-Template)
1415
- [Code Review Template](#Code-Review-Template)
1516
- [Optimization Template](#Optimization-Template)
@@ -64,9 +65,29 @@ For better results
6465
- Major refactoring
6566

6667
---
68+
## In-Code Documentation Template
6769

68-
## Debugging Template
70+
```Markdown
71+
### in-Code Documentation Request
72+
73+
🎯 Task: [one-line description]
74+
75+
📝 Specifications:
76+
- Lang: [language]
77+
- Input: [what I have]
78+
- Output: [what's needed]
6979

80+
✨ Extra (optional):
81+
- Dependencies: [if needed]
82+
- Constraints: [if any]
83+
84+
💻 Current Code (if present):
85+
```[language]
86+
[existing code]
87+
```.
88+
```
89+
90+
## Debugging Template
7091

7192
###### When to Use the Template🎓
7293
- Production issues

IT/protocollo_codice_avanzato.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
Template per generazione efficiente di codice tramite, query strutturate e modifiche avanzate.
99

1010
## Indice
11+
- [Template per Documentazione In-Code](#Template-per-Documentazione-In-Code)
1112
- [Template per Debugging](#Template-per-Debugging)
1213
- [Template per Code Review](#Template-per-Review)
1314
- [Template per Ottimizzazione](#Template-per-Ottimizzazione)
@@ -59,6 +60,28 @@ Per migliori risultati
5960
- Refactoring major
6061

6162
---
63+
## Template per Documentazione In-Code
64+
65+
```Markdown
66+
### in-Code Documentation Request
67+
68+
🎯 Task: [descrizione one-line]
69+
70+
📝 Specifiche:
71+
- Lang: [linguaggio]
72+
- Input: [cosa ho]
73+
- Output: [cosa serve]
74+
75+
✨ Extra (opzionale):
76+
- Dipendenze: [se necessarie]
77+
- Vincoli: [se presenti]
78+
79+
💻 Current Code (if present):
80+
```[language]
81+
[existing code]
82+
```.
83+
```
84+
6285
## Template per Debugging
6386

6487
###### Quando Usare il Template🎓

IT/protocollo_codice_smart.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,6 @@ def process_data(data):
146146

147147
```
148148

149-
150-
151149
---
152150

153151
#QuickCode #Development #Template

0 commit comments

Comments
 (0)