Scriverò documentazione per sviluppatori, documenti API e un readme chiaro

La tua libreria è buona. Il tuo README è di tre righe e un TODO. Ecco perché nessuno la adotta.

Sono un ingegnere del software con oltre 10 anni di esperienza in .NET, Python e DevOps, e scrivo la documentazione che vorrei trovassero negli altri progetti.

COSA OTTIENI

- Un README che porta qualcuno dal clonare all'esecuzione in cinque minuti

- Riferimento API scritto dal tuo codice reale, non indovinato dai nomi

- Esempi funzionanti - li eseguo tutti prima di consegnarli

- Sezioni chiare di installazione, configurazione e risoluzione dei problemi

- Markdown, MkDocs, Docusaurus o file semplici

- Inglese o tedesco (madrelingua)

IDEALE PER

Responsabili di open-source, team SDK e API, team di piattaforme interne e fondatori che hanno bisogno di documentazione prima di un lancio o di un round di finanziamenti.

INVIA MEE

Accesso al repository (basta leggere), chi è il lettore - utente finale, integratore o collega - e qualsiasi cosa che attualmente confonde le persone. Le tue tre domande di supporto principali valgono più di una specifica.

Non conservo credenziali. NDA benvenuto.

Documentazione in crescita? Chiedi di un abbonamento - una quantità fissa di lavoro di documentazione ogni mese, senza ri-briefing.