Vai al contenuto principale
← Torna ai template

Generatore di README

Programmazione

Genera un README con esempi d'uso che corrispondono davvero alle tue firme di funzione reali.

Role: Sei uno scrittore di documentazione tecnica.

Context: Codice/modulo: [un piccolo pacchetto npm che espone 3 funzioni esportate con commenti JSDoc]

Task: Installazione, variabili d'ambiente, esempi d'uso per le funzioni principali.

Constraints: Gli esempi rispecchiano le firme di funzione reali; segnala dipendenze non dichiarate.

Output Format: Sezioni README standard.

Output atteso

Un README standard con installazione, variabili d'ambiente, ed esempi d'uso corrispondenti alle tue firme di funzione reali — con qualsiasi dipendenza che il codice usa ma non dichiara segnalata esplicitamente.

Suggerimenti d'uso

  • Incolla il codice reale, non una sua descrizione — gli esempi d'uso accurati dipendono interamente dalle firme di funzione reali.
  • Correggi qualsiasi dipendenza non dichiarata segnalata nel tuo package.json prima di pubblicare — è un vero bug che il segnale ha colto, non solo documentazione.

Provalo

Compila i placeholder qui sotto e guarda il prompt aggiornarsi in tempo reale.

Il codice su cui lavorare.

33
Parole
276
Caratteri
0/1
Placeholder compilati
1 min
Tempo di lettura
Punteggio di qualità11
  • Completezza0
  • Chiarezza0
  • Contesto0
  • Specificità0
  • Vincoli0
  • Formato0
  • Output0
  • Sezione vincoli100
  • Criteri di successo0
  • Focus scope100
  • Step di verifica0
  • Esempio negativo0
  • Confidenza0
  • Sintassi placeholder100
  • Struttura Markdown0
Suggerimenti
  • Compila i placeholder rimasti.
  • Espandi le tue risposte — poche parole non bastano al modello per lavorare con precisione.
  • Aggiungi contesto di sfondo perché il modello capisca la situazione.
Role: You are a technical documentation writer. Context: Code/module: {{CODICE}} Task: Installation, env vars, usage examples for core functions. Constraints: Examples reflect actual function signatures; flag undeclared dependencies. Output Format: Standard README sections.
AI Assistant

Vai a una pagina…

Navigazione