Comment écrire de la documentation technique d'un site web/logiciel pour les nouveaux développeurs?

Je veux faire une documentation technique d'un site web existant pour les développeurs afin que les nouveaux développeurs peuvent continuer à travailler avec elle. Dans les codes existants, peu (ou pas du tout) dans les commentaires de code ou doc-les chaînes de caractères sont disponibles (mauvaise pratique, je sais). Ouais, j'ai vu certains messages liés à ces. Mais ceux qui n'ont pas été détaillés. Voici mes questions:

  • Quoi?
  • Comment l'organiser? Je veux dire, pouvez-vous suggérer une certaine hiérarchie, de sorte que les nouveaux développeurs peuvent facilement obtenir sur la piste?
  • Quelles sont les meilleures pratiques?
  • Pouvez-vous montrer quelques échantillons?
  • Comment cela peut-il être facile? Certains ppl suggère outil wiki mais je ne sais rien à ce sujet, il sera utile? Pouvez-vous suggérer n'importe quel outil de certaines de départ rapide tutoriel?

Je n'ai jamais fait un. Donc, j'apprécie tout genre de réponse. Merci à l'avance.
(Les liens seront utiles, mais s'il vous plaît donner un moyen rapide et lucide sommaire)

OriginalL'auteur mshsayem | 2009-09-01