Création helpfile en HTML

Question

Je suis face à la tâche amusante de créer un fichier d'aide pour un grand projet. J'ai jeté les fichiers CHM en raison des contraintes et sont maintenant à la recherche en fichiers HTML en fonction, mais je suis encore indécis sur le format ....

Il y a 3 domaines que je me concentre sur:

réutilisabilité des sections (plusieurs pages peut se référer à un texte) Étant donné que certaines sections seront utilisés plus d'une fois dans le fichier d'aide, je dois créer une section principale, puis créer un lien vers les sections de base dans chaque sous-section. Ce donc j'éviter d'avoir à changer les sous-titres multiples endroits lorsque vous effectuez des modifications.

Searchfunctionality Je voudrais être en mesure de rechercher du texte libre dans le fichier.

imprimabilité. L'utilisateur peut sélectionner les sections d'impression ou d'un document wholde.

Je suis d'abord penché à l'approche wiki ayant des plugins pour exporter le wiki dans les pages statiques pour la distribution, mais je ne l'ai pas trouvé cette solution ...

Toutes les suggestions de vous les gars dans cette affaire? Est-ce que je fais à helpfiles compliqué?

Merci d'avance!

Answer 1

réutilisabilité

Je vois deux approches. Vous pouvez créer des pages individuelles pour les sections que vous souhaitez réutiliser, puis relier simplement les le cas échéant. Ceci est trivial en HTML.

Vous pouvez alternativement créer un extrait ou d'un fragment de HTML avec les informations de cette section, puis utiliser les inclusions côté serveur (ou une technologie similaire) pour l'inclure en ligne partout où il est nécessaire. De cette façon, le contenu apparaît avoir été écrit sur chaque page individuelle, mais quand vous avez besoin de faire une modification il est encore que dans un seul endroit.

Rechercher

Si le site est public, laisser l'index de Google, et offrir juste une boîte de recherche Google. Vous n'êtes pas susceptible d'obtenir de meilleurs résultats que cela.

imprimabilité

« impression stylesheet » en CSS est facile à mettre ensemble, et peut éliminer tous les éléments graphiques qui rendent le site attractif sur le web, en conservant tout le contenu pour une utilisation sur le papier.

L'impression du document entier serait à la fois besoin d'un petit peu de programmation pour combiner tous les contenus ensemble en une seule page en vue de l'impression. Personnellement, je préfère offrir encore ce service, pour décourager les gens de gaspiller le papier.

Bien sûr, nous pouvons offrir toutes sortes de mieux comprendre comment parvenir à l'une de ces choses, mais comme il semble que vous êtes après des conseils généraux au moment, ce qui est à moi.

Answer 2

Je crois que les wikis sont parfaits pour la documentation, en particulier lorsque plus d'une personne est (ou sera) impliqué dans le projet. Lier entre les pages wiki ou namespaces est facile à réaliser. Renommer une page changera tous les liens hypertexte dans d'autres documents. Je voudrais éviter la duplication de contenu chaque fois que possible si, si c'est ce que vous suggérez.

J'utilise DokuWiki qui prend en charge l'exportation page. Vous pouvez vider votre wiki entier dans le texte brut, XHTML ou corps XHTML (pour mettre dans votre propre modèle, ou à ajouter à un fichier unique pour l'impression, etc.).

L'espoir qui aide!