[Prologue] L'écriture des développeurs doit être différente

Les développeurs ne savent pas écrire ?
Caractéristiques de la rédaction technique : exactitude, concision et lisibilité.
Rédaction du développeur

Chapitre 1 : Notions de base de l’écriture que les développeurs doivent connaître

01 Comment structurer les phrases et les paragraphes
Comment structurer des phrases ___
___Différences entre descriptif, réducteur et schématique
Style narratif et liste à puces révisés
___Hiérarchie qui structure les paragraphes
02 Espacement et ponctuation faciles à utiliser
___La règle d'espacement la plus simple
___Signes de ponctuation faciles à mal interpréter (guillemets doubles, guillemets simples)
03 Sélection des mots anglais et notation des mots étrangers
Choix de mots similaires mais différents
Étiquetage des produits étrangers et étiquetage des mots étrangers

Chapitre 2 : Nommer et commenter pour gagner du temps de développement

01 Conventions de dénomination : Comprendre la raison d’être et les utiliser
___Le principal souci des développeurs est le choix des noms.
Nommer n'est pas créer, mais combiner
___La convention de nommage du code hérite de la notation anglaise.
Nommez vos classes en notation Pascal
Nommer les fonctions et les variables en utilisant la notation camel
Les constantes sont écrites en lettres majuscules.
Les paquets et les modules sont écrits en minuscules
Notation BEM
___La lisibilité et la communication passent avant tout
02 Comment bien nommer les variables
___i est un nom de variable, mais d ne l'est pas.
Nom long ? Nom court ? Lequel est le plus facile à trouver ?
Dois-je ajouter un s pour indiquer le pluriel ou non ?
Dois-je utiliser l'abréviation ___ ou non ?
___Mettez les mots importants en premier
Ordre de dénomination des fonctions
03 La norme pour une bonne réputation, SMART
___On ne trouve pas un bon nom du premier coup
___5 Caractéristiques d'un bon nom
___Facile à rechercher : Comment nommer les choses pour faciliter la recherche
Faciles à mélanger : Comment nommer les choses faciles à combiner
___Facile à accepter : Comment nommer les choses faciles à accepter
___Facile à retenir : Comment rendre les noms faciles à mémoriser
___Facile à taper : Comment nommer les choses pour qu’elles soient faciles à taper
04 Un bon code ne contient pas de commentaires ?
Les noms peuvent réduire les commentaires.
Commençons par nous entraîner à coder sans commentaires.
Il existe de nombreuses situations où des commentaires sont nécessaires.
05 Rédigez des commentaires respectueux des autres développeurs
Le code véhicule une signification, les commentaires expriment une intention.
Répétition du commentaire
Extraits et résumés des commentaires de ___
Les commentaires sont aussi du code

Chapitre 3 : Rédiger des messages d’erreur qui communiquent avec les utilisateurs

01 Éliminons les erreurs avant de rédiger les messages d'erreur.
___Page 404 conviviale, page 404 non conviviale
Une erreur 404 est-elle quelque chose dont il faut s'excuser ?
Les liens brisés relèvent de la responsabilité du développeur.
___Séparons les messages d'erreur pour les développeurs et les utilisateurs.
02 Comment rédiger correctement les messages d'erreur destinés aux utilisateurs
Message relatif aux erreurs des utilisateurs
___pour afficher les messages d'erreur
Messages échangés et messages par bouton
03 Structuration des messages pour réduire les erreurs des utilisateurs
___ ordre des boutons
Comment empêcher les utilisateurs de commettre des erreurs répétées ?
04 Utilisez des messages préventifs plutôt que des messages d'erreur.
Comprendre le service ___ peut vous aider à éviter les erreurs.
Comprendre vos utilisateurs peut vous aider à éviter les erreurs.

Qui de la poule ou de l'œuf est apparu en premier ?

Chapitre 4 : Rédiger les documents de version et les rapports de bogues du point de vue du lecteur

01 Comment classer, résumer et synthétiser les journaux de modifications
Relation entre le nombre de journaux de modifications et la satisfaction
Étape 1 : Sélectionner
Étape 2 : Classification
Étape 3 : Résumer
Étape 4 : Synthétiser
02 Rédigez des informations utiles pour les clients.
___Point de vue du développeur et point de vue du client
Passons en revue le passé et voyons l'avenir
Versionnage sémantique
03 Rédigeons le document de version comme un rapport de dépannage.
Faisons la distinction entre problèmes et questions.
Notez dans cet ordre le problème, la question, la solution et le plan de suivi.
___Écrivons en tenant compte des aspects juridiques
04 Rédaction d'un rapport d'obstacles à la compréhension des affaires
___Caractéristiques du rapport d'invalidité
Répondre rapidement aux questions
Écriture analytique qui recherche les causes et les raisons de ___
Écrire d'un point de vue professionnel qui tient compte de ___votre supérieur
Des écrits politiques qui vous apportent ce que vous désirez

Chapitre 5 : Rédiger un guide de développement avec description, argumentation et récit

01 Expliquons le concept de service en termes de catégories, de finalités et de caractéristiques.
___Catégorie, Utilisation, Caractéristiques
Choisissons la catégorie ___ avec précision et pertinence.
Décrivons cet objectif comme une fonction essentielle de la catégorie.
Mettons en évidence les caractéristiques de ___ parmi ses avantages et ses points forts.
02 Décrivons-le avec des images et des mots afin qu'il puisse être compris avec précision.
Si vous ajoutez des descriptions au texte, il sera plus facile à comprendre.
Associez le texte et l'image
___Faisons à la fois des descriptions objectives et subjectives
03 Fournir des informations utiles par le biais d'arguments
Si vous souhaitez exprimer une opinion, fournissez des preuves.
N'écrivons ni de manière abrupte ni de manière polie.
___Écrivons en réduisant l'écart entre l'affirmation et la justification.
___Écrivons en réduisant la distance entre la question et la réponse.
04 Créer une table des matières narrative
___Développement et narration
Écrivons en nous basant sur l'universalité de la technologie plutôt que sur le niveau du lecteur.
Créons une table des matières à partir des étapes dans l'ordre ___.

Chapitre 6 : Rédiger des propositions de systèmes d’information pour remporter des commandes

Principes de rédaction de propositions que les développeurs doivent connaître
___Différences entre les développeurs et les chefs de projet de proposition
L'essence de l'architecture du système ___ n'est pas une image.
Tout d'abord, analysez l'appel d'offres.
Deuxièmement, la complétude logique
02 Identification du problème par le client et capacité du proposant à résoudre le problème
Compétences en matière de reconnaissance et de résolution de problèmes
______① Faites une suggestion en la comparant à vos concurrents.
______② Tout d'abord, mettez-vous d'accord, puis proposez une autre solution.
______③ Sensibiliser le client à la gravité du problème.
______④ Analysez les stratégies de vos concurrents et réagissez en conséquence.
03 Les besoins des clients sont voués à évoluer.
Le développement consiste à répondre aux besoins des clients
Ne pas analyser les exigences, présenter les informations.
___Préparez-vous à l'évolution des exigences
04 Améliorer la satisfaction globale des clients
Toutes les demandes ne sont pas identiques.
___Trois types de demandes selon le modèle de Kano

Chapitre 7 : Créer et gérer facilement un blog technique

01 3 façons simples d'écrire un blog technique
Pourquoi les développeurs écrivent-ils de mauvais blogs techniques ?
______Tout d'abord, concentrons-nous sur le contenu et non sur le sujet.
Deuxièmement, écrivez à votre propre niveau, et non à celui du lecteur.
Troisièmement, écrivons de manière amusante.
02 Comment créer une table des matières par type d'écrit I - Écriture
___4 Types de blogs technologiques, par, alcool, éditeur, maison
______I : Rédigeons le journal de développement à partir du texte principal, avec une bonne table des matières.
______alcool : Comparons et expérimentons avec le texte original et rédigeons une explication.
03 Comment créer une table des matières par type d'article II - Édition
______: Résumons la commande
______house : Si vous avez peur d’écrire, rassemblez vos données, résumez les points principaux et écrivez.
4 conseils pour gérer un blog technologique d'entreprise
Les blogs technologiques augmentent la valeur de votre entreprise.
Les blogs technologiques ont également besoin d'investissements pour survivre.
Les écrits des développeurs reflètent la culture de l'entreprise.
Essayons d'écrire en collaboration, en binôme.

[Épilogue] Proposons une formation à la rédaction pour développeurs au sein de notre entreprise