Crear archivo de ayuda en formato HTML

Question

Estoy frente a la divertida tarea de crear un Archivo de Ayuda para un proyecto grande.He descartado archivos CHM debido a las restricciones y en la actualidad están buscando en HTML basado en archivos, pero todavía estoy indeciso en el formato....

Hay 3 áreas que me estoy centrando en:

La reutilización de las secciones (muchas páginas, puede hacer referencia a un texto) Desde algunos sectores se utiliza más de una vez en el archivo de ayuda, necesito crear un maestro de la sección y, a continuación, vincular a la maestra de las secciones en cada subsección.Este y así evitar tener que cambiar el título múltiples lugares al hacer modificaciones.

Searchfunctionality Me gustaría ser capaz de búsqueda de texto libre en el archivo.

La capacidad de impresión.El usuario puede seleccionar para imprimir secciones o wholde documento.

Yo era la primera que se inclina la wiki método tiene plugins para exportar la wiki a las páginas estáticas para la distribución, pero no he encontrado la solución...

Cualquier sugerencia de ustedes en este asunto?Estoy haciendo helpfiles a la complicada?

Gracias de antemano!

Answer 1

Reutilización

Veo dos enfoques. Puede crear páginas individuales para las secciones que desee volver a utilizar, y luego simplemente enlazar a ellos siempre que sea apropiado. Esto es trivial en HTML.

Incluye

Puede crear alternativamente un fragmento o fragmento de HTML con la información de esa sección, y luego usar el lado del servidor (o una tecnología similar) para incluirlo en línea donde se necesite. De esta manera aparecerá el contenido que ha sido escrito en cada página individual, pero cuando se necesita para hacer una edición que es todavía sólo en un solo lugar.

Buscar

Si el sitio es público, dejar que Google indexará, y sólo ofrecen una caja de búsqueda de Google. No es probable que obtenga mejores resultados que eso.

Capacidad de impresión

Una "hoja de estilo de impresión" en la CSS es fácil de armar, y puede eliminar todos los elementos gráficos que hacen que el sitio atractivo en la web, conservando todo el contenido para su uso en el papel.

Impresión de todo el documento a la vez requeriría algún pequeño fragmento de la programación para combinar todos los contenidos juntos en una sola página con el propósito de impresión. En lo personal, prefiero incluso ofrecer ese servicio, la gente deje de perder el papel.

Por supuesto, podemos ofrecer todo tipo de información sobre cómo lograr cualquiera de estas cosas, pero ya que parece que estás después de un consejo general en este momento, que es el mío.

Answer 2

Creo wikis son perfectos para la documentación, especialmente cuando más de una persona es (o será) que participan en el proyecto. La vinculación entre las páginas wiki o espacios de nombres es fácil de lograr. Cambiar el nombre de una página cambiará todos los hipervínculos de otros documentos. Yo evitaría la duplicación de contenido siempre que sea posible, sin embargo, si eso es lo que estaba sugiriendo.

DokuWili que soporta la página de exportación. Se puede volcar toda su wiki en texto plano, XHTML o cuerpo XHTML (para poner dentro de su propia plantilla, o para añadir a un solo archivo a imprimir, etc.).

Espero que ayude!