Outil indépendant de plate-forme pour la création de la documentation/proposition d'API

Question

Quels sont les outils disponibles pour développer une documentation d'API indépendante de la plate-forme?

Je suis en train de concevoir une API proposée, et que vous souhaitez écrire la documentation de manière structurée et facilement modifiable. La plupart des réponses que j'ai vues ont été essentiellement «Utiliser des outils de documentation spécifiques au langage», mais comme je conçois l'API à partir d'un «niveau supérieur» plutôt que de l'implémenter, ce n'est pas très utile. J'ai cherché un CMS pour la documentation API

J'ai vu quelques suggestions pour utiliser PBWiki ou Confluence, mais je ne suis pas convaincu qu'un wiki simple soit la meilleure option, bien que les aspects de contrôle de version soient agréables.

En théorie, construire Drupal avec CCK pour les appels API et vues pour la lecture de l'API, mais c'est un peu lourd pour ce levage je cherche.

Y at-il un système de gestion de la documentation de l'API là-bas? Quelles sont les meilleures options pour écrire et gérer la documentation indépendante des plates-formes pour les API?

Je l'ai vu related questions pour cela, mais il n'a pas encore une réponse satisfaisante.

Answer 1

Toute langue de texte structuré fera. J'utiliserais du latex, et troff est old school.

Mais vous avez manqué le point de la suggestion d'utiliser doxygen ou autre chose. Si vous faites cela, alors l'écriture de la documentation est également fixant l'échafaudage pour la mise en œuvre éventuelle. Mieux encore, la documentation d'exemple sera dans le même format que la documentation réelle et, bien sûr, vous utiliserez le contrôle de la source, n'est-ce pas? Donc, vous aurez un historique des modifications apportées à la spécification.