Comment rédiger un bon document (Guide étape par étape)

Tout n’est pas enregistré. Par conséquent, avant de répondre à la question « Comment rédiger un document », veuillez savoir si vous devez le documenter. Avant d’enregistrer, Considérez votre public cible. Le public cible du document peut être n’importe qui, de l’utilisateur final au développeur de logiciels ou au personnel des ressources humaines. Ce sont des travailleurs du savoir? Pensez aux problèmes que ces publics cibles essaient de résoudre… Si vous pouviez vraiment les autoriser à faire mieux en enregistrant.
De plus, pensez à la façon dont ils vont l’utiliser. Pensez à la façon dont les utilisateurs prévus interagiront avec votre document. Vos clients commenceront – ils à utiliser votre solution étape par étape selon votre documentation? Cela rend votre document « orienté vers l’objectif » Ou vos développeurs l’utiliseront – ils pour travailler et collaborer sur votre prochain cycle de publication? Dans ce cas, vous verrez un document axé sur la compréhension. Ou est – ce que vos ressources humaines se référeront à elle pour résoudre le problème? Il existe des documents axés sur l’information.
Vos documents peuvent – ils vraiment les aider? En outre, vous pouvez examiner comment votre travail de documentation vous aidera à atteindre un niveau plus élevé: votre document améliorera – t – il votre support de niveau zéro et permettra – t – il à vos utilisateurs finaux de résoudre eux – mêmes les problèmes (biais)? Cela permettra – t – il à votre équipe de faire mieux? Votre équipe deviendra – t – elle plus efficace? L’idée générale est de ne pas commencer trop tôt (ou trop tard) pour apprendre quand enregistrer. À moins que vous ne déterminiez comment un processus se déroulera réellement ou comment vous réaliserez votre « Vision », il est préférable de ne pas l’enregistrer et d’attendre que les choses se réalisent un peu.
Par exemple, n’utilisez pas risor si vous prévoyez une mise à niveau importante au cours du prochain trimestre et que le travail n’en est qu’à un stade avancé du concept.
Documentation C’est l’approche \
La chaîne Blackwell de yelp partage une certaine frustration lorsque tous vos documents ne sont pas correctement stockés en un seul endroit: vous avez un document qui explique tout le contenu du service et vous êtes sûr que l’information nécessaire pour résoudre cet événement est là, quelque part. \
Si vous Documentez votre équipe, choisissez une solution wiki comme wikipress ou une solution interne de gestion des connaissances herome knowledge base (Oui, double!). Ou, jetez un coup d’oeil à certaines des options de ces solutions de gestion des connaissances. Enfin, si vous voulez enregistrer le Code, vous devrez peut – être envisager des solutions de documentation technique plus spécialisées. Certaines solutions communes de base de connaissances, comme la solution de base de connaissances héroïque et la solution de documentation technique. Lorsque vous sélectionnez un système de documents, assurez – vous de choisir un système facile à mettre à jour, car vous pouvez vous retrouver à mettre à jour vos documents fréquemment! Vos outils de documentation
Izia a un fichier README. Il peut être considéré comme la couverture ou le contour d’un document.
Si vous enregistrez le Code que vos collègues (développeurs \ testeurs \ optimiseurs) utiliseront, votre fichier README sera affiché d’une manière ou d’une autre. Si vous écrivez un document client, vous voudrez peut – être l’adapter pour qu’il soit pertinent pour le public cible et le travail à accomplir. Toutefois, le contenu reste globalement inchangé. Ci – dessous, vous pouvez voir comment un article de support expliquant comment fonctionne l’intégration commence par sa propre couverture. Maintenant, en utilisant le mode README ou document, remplissez une section à la fois. Voici quelques ressources de notre blog qui peuvent vous aider à compiler vos documents: modèle d’article de base de connaissances faisant autorité (infographic): Nous avons analysé les articles de base de connaissances les plus réussis de nos clients et décodé l’apparence d’un excellent article de base de connaissances. Ces articles sont une partie importante de la documentation de l’utilisateur, donc Utilisez cette infographie pour les créer à un rythme record. Comment écrire des procédures d’exploitation normalisées détaillées (SOP): il s’agit d’un guide rapide sur la façon d’écrire des SOP ou des procédures d’exploitation normalisées qui fournit des instructions détaillées sur la façon de faire le travail prévu – utile lors de la création d’un wiki d’entreprise interne ou d’une base de connaissances. Qu’est – ce qu’un document de processus? Et comment documenter le processus de la bonne façon: un autre tutoriel rapide pour la documentation du processus, qui est une partie importante de la composition de la documentation au sein de l’entreprise. Comment écrire des FAQ et 5 façons simples d’écrire des réponses parfaites à vos FAQ: ces deux messages vous aideront à préparer vos FAQ en une heure et
En tant que patron, nous avons beaucoup de problèmes de pré – vente. Une fois terminé, n’oubliez pas d’ajouter une Section d’examen et de test. La révision est un élément important du processus de documentation. Il vous aide à vous assurer que le document est vraiment valide. Dans son processus en cinq étapes d’examen des documents, l’auteur technique Tom Johnson souligne que la première étape ne doit pas être manquée et qu’en tant qu’auteur de documents, vous pouvez suivre les étapes que vous avez écrites pour que le produit « fonctionne pour vous – même ». Le document de mise à jour des paramètres commence à geler dès sa publication. Donc vous avez besoin d’un programme de mise à jour. Le taux de rafraîchissement dépendra du document que vous consultez. Par exemple, les documents de l’utilisateur ne doivent être mis à jour que lorsque le produit est mis à jour. Documentation du développeur – documentation du Code technique – toujours en cours (documentation en ligne). D’autre part, vos connaissances internes et vos documents de travail peuvent être mis à jour chaque fois que des changements surviennent, par exemple lorsque vous remplacez les outils actuels de gestion de projet, ou même lorsque vous découvrez simplement une façon plus optimale de travailler. L’acquisition de connaissances tribales et l’acquisition de connaissances générales sont quelques – uns des exercices en cours dans le présent document. Si cela a du sens, enregistrez les changements dans le document afin que les utilisateurs ne se sentent pas perdus lorsqu’ils voient la version mise à jour. De plus, il supprime les fichiers périmés et en double dans le cadre de la mise à jour du document. La recherche de documents ne doit pas renvoyer plus d’une version du même contenu pris en charge. Une seule ressource est nécessaire pour chaque sujet. Pour l’entourer… Après avoir développé des informations sur la façon d’écrire des documents pour s’adapter
Non seulement cela vous aide – t – il à normaliser l’écriture de vos documents, mais cela permet également à d’autres personnes de construire sur cette base, car les documents sont toujours en cours. Passe – le – moi. Comment écrivez – vous actuellement votre document?