CHAPITRE 1 Comprendre le lecteur

Un mois avant le lancement de l'application Corg.ly
La malédiction du savoir
_Dessin d'utilisateur
_Vérifier la compréhension de l'utilisateur
_Compression des résultats des enquêtes auprès des utilisateurs
_Création d'un journal de friction
_addition

CHAPITRE 2 : DOCUMENTATION DE PLANIFICATION

Création d'un plan de documentation pour une application _Corg.ly
_Plans et modèles de documentation
_Type de contenu
_addition

CHAPITRE 3 Création d'un brouillon de document

Première ébauche de l'application Corg.ly
_Face à une page blanche (écran)
_Préparation à la rédaction de documents réussie
_Écrire un plan
Rédigez un brouillon
Rédiger des documents en tenant compte de la lecture rapide
Se sortir d'une situation bloquée
_Commencez à écrire avec un modèle
_Fin de la première ébauche
_addition

CHAPITRE 4 Modification de documents

Modification du contenu de l'application _Corg.ly
Modifiez selon vos besoins
_Différentes approches de l'édition
_Créer un processus d'édition
Recevoir des commentaires et en tenir compte
_Fournissez des commentaires positifs
_addition

CHAPITRE 5 Intégration d'exemples de code

_Montrer comment fonctionne l'application Corg.ly
_Utilisation d'un exemple de code
_Types de code d'exemple
_Principes d'un bon exemple de code
_Conception d'un exemple de code
_Outils pour les exemples de code
_addition

CHAPITRE 6 Ajout de contenu visuel

L'application _Corg.ly vaut mille mots…
Quand les mots ne suffisent pas
Pourquoi la création de contenu visuel est difficile
_Utilisation de captures d'écran
_Types de diagrammes courants
_Dessiner un diagramme
_Création de contenu vidéo
_Examen du contenu visuel
_Maintenir le contenu visuel
_addition

CHAPITRE 7 Distribution des documents

Distribuez l'application Corg.ly !
_Présentation du contenu
_Élaboration d'un processus de publication de contenu
_Création d'un calendrier de distribution
Se préparer pour l'avenir
_addition

CHAPITRE 8 : Collecte et intégration des commentaires

premier retour d'information sur l'application _Corg.ly
_Écouter les commentaires des utilisateurs
_Créer un canal de commentaires
Tenir compte des commentaires
_addition

CHAPITRE 9 Mesurer la qualité des documents

L'application _Corg.ly sera lancée mardi prochain
Le document que j'ai écrit est-il correct ?
_Comprendre la qualité des documents
Élaboration d'une stratégie d'analyse
Conseils pour l'utilisation des métriques de documents
_addition

CHAPITRE 10 Structuration des documents

Prochaine version de l'application _Corg.ly
_Structurer les documents pour les lecteurs
_Aider les lecteurs à trouver leur chemin
_Structurer votre document
_addition

CHAPITRE 11 Arrêt de la maintenance et du support des documents

Après plusieurs versions de l'application _Corg.ly
_Maintenez votre documentation à jour
_Planification de la maintenance
_Automatisation de la maintenance des documents
Suppression de contenu d'un ensemble de documents
_addition

Annexe A.
Qu’en est-il de la rédaction technique nationale ?
Annexe B.
Quand faire appel à un professionnel
Annexe C.
Références

Annexe spéciale : Entretiens avec 11 rédacteurs techniques nationaux

« Si tu continues à écrire, tu t'amélioreras. »
- « Frères élégants » de Yoo Young-kyung

Rédacteurs techniques : personnes responsables de la documentation technique
— Kim Yu-ri, Kakao Enterprise

L'histoire d'un docteur en astrophysique devenu rédacteur technique en apprentissage automatique AWS
- Choi Mi-young, AWS

« L'histoire d'un rédacteur technique de deuxième génération »
- Jeon Jeong-eun 〈LINE Plus〉

« L’attitude que devrait avoir un rédacteur technique »
- Lim Geun-hee, Coupang

Rédacteur technique en tant que profession
- Park Seon-young, NHN Cloud

Le rôle d'un rédacteur technique chez LINE
- Lee In-sil 〈LINE Plus〉

« L'attitude du rédacteur technique »
- Nam Jeong-hyeon (Devsisters)

« Expériences et brèves réflexions d'un rédacteur technique en entreprise informatique »
- Kang Jeong-il (LINE Plus)

« L'histoire d'un rédacteur technique »
- Lee Jung-min (Netmarble)

« Un rédacteur technique est un collègue comme les autres. »
- Jo Byeong-seung (Netmarble)

Documentation technique : une histoire pour tous les acteurs de l'écosystème du développement

Il est important d'intégrer une bonne documentation et une bonne programmation.
Un projet bien documenté profite à la fois aux développeurs et aux utilisateurs.
Les projets dépourvus de documentation technique adéquate souffrent non seulement d'une productivité réduite des développeurs, d'une évolutivité, d'une adoption par les utilisateurs et d'une accessibilité moindres, mais diminuent également les chances de succès du projet.
Une bonne documentation est essentielle à l'avancement du projet.


Ce livre décrit le processus de création de la documentation pour les développeurs, à travers le prisme d'une équipe de développement logiciel hypothétique travaillant sur le lancement d'un nouveau produit.
Nous vous guiderons tout au long du processus, de la recherche des besoins de vos utilisateurs et de la planification à la rédaction et à la modification du contenu et à sa distribution, en suivant les modèles de documentation courants.
Nous fournissons également des conseils pratiques sur la gestion de votre documentation à mesure qu'elle s'étoffe, notamment en recueillant des commentaires et en mesurant son efficacité après déploiement.


De plus, nous avons inclus des entretiens avec 11 rédacteurs techniques coréens de renom qui n'étaient pas inclus dans le livre original, offrant des témoignages sur le travail de rédacteurs techniques travaillant dans diverses entreprises, ainsi que des anecdotes utiles tirées de nos propres expériences en tant que rédacteurs techniques seniors.

Public cible

- Les développeurs de logiciels qui doivent rédiger de la documentation en plus du code
- Les responsables produits et les responsables des relations avec les développeurs qui doivent comprendre le produit et le service dans leur ensemble
- Les blogueurs techniques qui souhaitent partager leur expérience ou leurs connaissances en matière de développement
- Rédacteurs techniques qui rédigent la documentation sur les produits et services
- Développeur externe devant rédiger une proposition d'intégration de système

Ce que ce livre couvre

- Créer des journaux de friction et mener des études auprès des utilisateurs afin de comprendre leurs besoins.
- Rechercher, rédiger et finaliser le contenu de différents types de documentation, notamment les fichiers README, la documentation API, les tutoriels, les documents de concept et les notes de version.
Après la diffusion des documents, nous maintenons la qualité du contenu grâce aux retours des utilisateurs.

- Suivre le processus du projet et organiser les tâches à accomplir étape par étape.