Outil de type wiki pour la rédaction des spécifications et de la documentation [fermé]


9

Je recherche un wiki ou un système de type wiki pour écrire et gérer les spécifications et la documentation d'un projet logiciel.

Je sais qu'il existe de nombreuses implémentations wiki disponibles, mais y en a-t-il qui sont particulièrement bien adaptés à ce genre de tâche?

En fait, il n'est pas nécessaire que ce soit un wiki, juste un système qui facilite la rédaction et la navigation des spécifications et de la documentation, et qui prend en charge le suivi des modifications.


1
Utilisez-vous une plate-forme spéciale? Comme le TFS de Microsoft par exemple?
Saeed Neamati

Dans la lignée de ce que @Saeed a demandé, quels types d'infrastructure votre équipe / organisation a-t-elle déjà en place pour la gestion et le partage des connaissances? De plus, quels sont vos processus actuels pour rédiger des spécifications et des documents?
Thomas Owens

Réponses:


6

Nous utilisons LaTeX et SVN. Étant donné que les documents LaTeX ne sont que des fichiers texte, il joue bien avec le contrôle de version, contrairement à certains formats binaires ou partiellement binaires.

Vous bénéficiez de tous les avantages (et inconvénients, certes) du contrôle de version auquel vous êtes habitué en l'utilisant avec votre code.

LaTeX prend un peu de configuration (pour définir vos propres styles / classe), mais une fois que vous l'avez fait, c'est très bien - vous pouvez vous concentrer uniquement sur le contenu plutôt que sur sa présentation (plutôt que d'être tenté de modifier constamment comme vous êtes avec WYSIWYG), tout en obtenant un document PDF élégant et professionnel à la fin.


4

Personnellement, j'aime vraiment Tiddly Wiki .

Il a une syntaxe wiki assez complète, est un seul fichier html autonome et fonctionne bien avec une variété de navigateurs Web sans avoir besoin d'un serveur.

Il a même une architecture de plugin extensible qui vous permet d'ajouter des plugins pour faire toutes sortes de choses intéressantes comme le cryptage des tiddlers ou l'ajout de notes de bas de page.


3

Pour la plate-forme Microsoft, l'intégration TFS (Team Foundation Server) avec SharePoint est exactement ce que vous recherchez. En créant un nouveau projet d'équipe, vous pouvez choisir un modèle englobant presque tous les aspects du processus de développement logiciel. Il vous donne un portail dans lequel vous pouvez définir les membres de l'équipe, attribuer leurs rôles et autorisations de sécurité, télécharger, partager et modifier des documents et des spécifications liés à votre projet, et faire beaucoup d'autres choses intéressantes avec lui.

Pour les autres plates-formes, je pense que vous pouvez utiliser quelque chose comme GitHub (cependant, je n'en suis pas sûr).


0

Pour le projet personnel (qui n'existe que sur mon PC), j'utilise Wiki in a Jar . Dans le passé, j'ai travaillé avec Redmine (il dispose en outre d'un système de suivi des bogues et de SCM)


0

Vous pouvez essayer Sphinx , avec les documents archivés dans votre infrastructure de gestion de contrôle de source de choix. Cela présente les avantages du contrôle de code source et d'un langage de balisage relativement léger, reStructuredText , qui est facile à apprendre et assez bien instrumenté pour les conversions (en HTML, en PDF, etc.).

En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.