Scriverò documentazione tecnica su software, IT e tecnologia

Ciao;

La scrittura tecnica fallisce in un modo, costantemente: è scritta da qualcuno che già comprende il sistema, per qualcuno che ancora non lo fa. È in quella lacuna che lavoro, coprendo lo sviluppo software, i progetti IT e i contenuti tecnologici in modo più ampio.

Questo include:

• Documentazione API, endpoint, parametri ed esempi che funzionano davvero se copiati
• File README e guide di configurazione, passaggi nell'ordine corretto, assunzioni rese esplicite
• Guide di implementazione, specifiche di sistema, documenti sui processi interni per la documentazione di progetti IT
• Articoli e report tecnologici che spiegano come funziona qualcosa o perché è importante, per un lettore che non è ancora un esperto
• Runbook e documenti di troubleshooting scritti per chi si trova bloccato alle 2 di notte, non per chi l'ha costruito

Focus principale:

• Report di sviluppo software
• Scrittura di report tecnici
• Blog tecnici
• Report IT
• Data Mining
• Big Data
• Cloud computing
• Contenuti per siti web
• IOT
• Report richiesti dagli utenti
• Tutte le tipologie di report tecnici
• Altri scritti tecnici

Condividi i tuoi documenti, specifiche o argomenti e la tua scadenza per iniziare.