The latest articles on DEV Community by Sarah Haïm-Lubczanski (@mereteresa). https://dev.to/mereteresa https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F724011%2F33fb15d4-07e0-45f7-baae-633579e6bbf7.jpeg https://dev.to/mereteresa en Sarah Haïm-Lubczanski Tue, 26 Mar 2024 16:28:09 +0000 https://dev.to/mereteresa/documentation-style-guide-you-said-484p https://dev.to/mereteresa/documentation-style-guide-you-said-484p <p>Suite à l'article (en 2 parties) sur <a href="https://dev.to/onepoint/structurer-votre-doc-pour-la-rendre-utile-2a9c">comment structurer une documentation technique</a>, j'ai remarqué qu'il manquait la partie Style Guide. </p> <p>Un Style Guide, c'est l'équivalent de <a href="https://www.php-fig.org/psr/psr-12/">PSR-12 pour PHP</a> ou des <a href="https://peps.python.org/pep-0008/">PEP 8 pour Python</a>, l'idée est de guider la personne qui rédige la documentation, pour lui faciliter le travail.</p> <p>Par exemple, faut-il écrire en français, ou en anglais ? Au présent ou au passé ? Tutoyer ou vouvoyer, ou même éviter l'adresse au lecteur-ice ?</p> <p>Est-ce que le mot correct est <code>backend</code>, <code>back-end</code> ou <code>back end</code> ?</p> <p>Si tous ces détails vous semblent pertinents pour améliorer la qualité de votre documentation (que les docs soient homogènes, notamment), il vous faut un Style Guide de doc.<br> Pour trouver un Style Guide existant à suivre (par exemple, <a href="https://developers.google.com/style">celui de Google Developers</a>), voici une ressource intéressante :<br><br> <a href="https://www.writethedocs.org/guide/writing/style-guides/#how-to-articles-for-writing-a-style-guide">https://www.writethedocs.org/guide/writing/style-guides/#how-to-articles-for-writing-a-style-guide</a></p> documentation styleguide writing french