Sur Le Document Source: Dix Choses Programmeur Peut Ignorer

Les documents de la plupart des projets de sources ouvertes sont extrêmement décevants, principalement dans les domaines suivants.

Absence d 'un bon exposé ou exposé

L 'auto - présentation est la première impression de l' utilisateur potentiel sur votre projet.

Si l 'élément est sur github, il est automatiquement affiché sur la page d' accueil du projet.

Si vous vous trompez un peu, ces utilisateurs potentiels ne reviendront peut - être plus.

Donc tu le projet doit avoir un bon README pour attirer l'intérêt des projets pour vous.

Fichier README devraient au moins comprendre les points suivants:

? Ce projet;

? Quelle orientée utilisateur;

? s'étend sur ce matériel ou de plate - forme;

? Les relations de dépendance;

? Comment installer ou en direction du pointeur.

C'est pour ceux qui n'ont jamais entendu parler de votre projet et peut - être même jamais de prendre en compte les utilisateurs de votre projet.

Bien s?r, je ne pense pas que chaque utilisateur de lire ta README savent ce que c'est, le temps nécessaire à faire quelques commentaires et enfermer des liens utiles de l'utilisateur, facile à comprendre votre projet.

2. Ne fournit pas de documents en ligne

Bien qu 'aucune étude n' ait été réalisée à ce sujet, je pense que 90% des documents sont recherchés par Google ou par d 'autres navigateurs internet.

Le document doit donc être en ligne et disponible.

Comment puis - je le découvrir? Parce que beaucoup d 'utilisateurs ne regardent pas souvent les réponses aux questions courantes et recherchent directement les réponses en ligne, ce qui pose souvent des problèmes dans les projets.

Ainsi, la fourniture de documents en ligne peut aider les utilisateurs à mieux résoudre les problèmes.

Seuls les documents en ligne

De l'autre c?té de cette question est le développement du personnel concerne uniquement la ligne du document.

Document de certains projets ne vient pas avec le projet peut être interactive, ou contient un document est la version n'est pas conforme.

Par exemple PHP sans aucune documentation, si vous voulez le document doit être utilisé avec une seule page pour les ouvrir.

Mais le pire, c'est que le Code de noyau peut être téléchargé.

Ce qui amène un utilisateur ne peut pas obtenir des informations utiles sur leur propre.

Le projet Open source ne veut pas nécessairement croire que les utilisateurs ont besoin de documents en ligne lorsqu 'ils ont accès à Internet.

Bien s?r, vous ne voulez pas que les utilisateurs soient trop dépendants de votre site Web.

Non compris les documents d 'installation

Ce problème se pose généralement aux créateurs de paquets et non aux promoteurs de projets.

Par exemple, dans le système d 'exploitation Ubuntu Linux, le paquet sélectionné en langue Perl est lui - même un document distinct.

L 'utilisateur doit conna?tre les documents d' installation et les documents dans la langue de base dont il a besoin au moment de l 'installation, ce qui lui permet de résoudre les problèmes en temps voulu.

Absence de cartes

Y a - t - il un meilleur moyen d 'attirer l' attention des utilisateurs potentiels ou de justifier l 'utilisation correcte des logiciels?

A l 'ère de l' Internet, une carte vaut peut - être plus que des milliers de mots.

La carte permet à l 'utilisateur de déterminer si la méthode utilisée est correcte et de trouver facilement l' endroit où il se trompe.

Par conséquent nécessaire dans la capture d'écran pour document source est également cruciale.

6. L'absence de cas

Code pour la capture d'écran simulé sur la base du projet, c'est très bien, mais les exemples est indispensable.

Ces exemples ne devrait pas être abstraite, mais plut?t du monde réel extraites.

Passer du temps à créer des instances et des projets connexes, de montrer à l'utilisateur comment résoudre les problèmes apparaissant dans le processus d'utilisation de logiciel.

Si vous avez des hyperliens, utilisez - les dans le document.

Ne croyez pas que l 'utilisateur puisse comprendre et comprendre après avoir lu le document, il peut exister dans le document une partie de ce que l' utilisateur ne comprend pas.

Il a besoin de vous à l'aide de vous tous des hyperliens avec des références pour aider l'utilisateur à résoudre certains problèmes.

8. Oublie de nouveaux utilisateurs

Quand tu écris un document, vous êtes en vue du point de vue des développeurs de leurs préparé, c'est pour les développeurs de logiciels très facile.

Mais pour ceux qui en ont besoin de nouveaux utilisateurs, l'entrée de documents.

Afin de permettre à de nouveaux utilisateurs dès que possible la comprendre votre logiciel ou ma?triser des procédés d'utilisation de logiciel, je pense que nous devrions utiliser séparément de la page pour l'écriture de l'utilisateur pour l'entrée de documents.

Les concepteurs de projets doivent être à l 'écoute des besoins des utilisateurs pour l' ensemble du projet.

Le moyen le plus efficace est de faire en sorte que davantage de gens testent votre projet pour identifier les problèmes.

Il est tout aussi important que les concepteurs de projets tiennent compte, lorsqu 'ils écoutent les besoins des utilisateurs, des véritables raisons qui expliquent ces problèmes.

Si vous avez un groupe d 'utilisateurs assez important, vous pouvez demander à l' utilisateur d 'ajouter ses commentaires directement au document.

Le meilleur exemple que j 'ai vu est la langue PHP, dont chaque page dans un document permet à un utilisateur authentifié d' ajouter des commentaires ou d 'ajouter des commentaires qui ne font pas partie du document de base.