›

Documentation d'application

APAP Membre
17:12 modifié dans API AppKit #1
Bonjour,

Ce n'est pas du cocoa pur, donc si vous pensez qu'une autre catégorie est plus appropriée, n'hésitez pas.

Je termine actuellement une version alpha d'une application cocoa et me demandais quelles étaient les standards, bonne pratiques et outils pour réaliser la documentation d'une appli cocoa.

Merci d'avance pour votre aide :)

Réponses

  • tabliertablier Membre
    septembre 2010 modifié #2
    Il y a deux cas: soit il s'agit d'une documentation séparée et là  tu fais ce que tu veux, soit c'est le help en ligne et là  tu regardes comment Apple fait ses help en ligne pour avoir les bonnes règles.
    Pour ma part, ce que je déteste, ce sont les help en ligne qui renvoient à  un site sur le réseau! Cela, pour moi, ce sont des abominations car je n'ai pas toujours accès au Web et je me retrouve sans documentation. De plus, si tu ne suis pas les mises à  jour, tu te retrouves avec des documentations qui ne correspondent pas au programme que tu possèdes.

    Pour le help en ligne, tu fais cela en html c'est le plus simple. Il existe un "help indexer" livré avec Xcode.
  • AliGatorAliGator Membre, Modérateur
    17:12 modifié #3
    En effet.
    Tu trouveras toutes les informations nécessaires dans le Apple Help Programming Guide qui t'indique à  la fois les bonnes pratiques, comment créer un package d'aide (qui est en gros un bundle contenant des fichiers HTML en effet) et comment bien le faire pour qu'il soit correctement indexé (et faciliter la recherche dans ta doc pour l'utilisateur), etc.
Connectez-vous ou Inscrivez-vous pour répondre.