Articles of documentation

TFS vs SharePoint: ¿cuál es la mejor location para almacenar documentation?

Por lo general, las personas de negocios mantienen sus documentos en el portal de SharePoint. Soy (como desarrollador) preferiría mantenerlos en TFS (o en cualquier otro repository de código fuente) más cerca del código fuente. También en el último caso haría la estructura de carpetas en forma de "Src", "Doc", "Datos" para mantener todo más […]

documentation desplegable basada en wiki

Estoy buscando un proyecto de wiki editable por los desarrolladores y puede tener comentarios e historial, al igual que todo lo demás, pero también tiene las siguientes características: Una forma de labelr o versionar el wiki en una interfaz intuitiva que cualquier desarrollador competente puede usar Una forma de implementar una instantánea labelda o versionada […]

En SCM, ¿qué es una list de materiales?

Al leer sobre SCM (mgt de configuration de software, no mgt de cadena de suministro), he visto mencionar una "Lista de materiales" como un documento proporcionado con una compilation. ¿Qué se incluye en el documento de la Lista de materiales y cuál es su propósito? ¿Es este un documento de uso común?

¿Cuál es la opinión de todos sobre los comentarios "documentales" (es decir, no funcionales)?

Así que tenemos sistemas de control de versiones sofisticados en estos días donde podemos comentar sobre los cambios realizados en el código. ¿Es más relevante poner comentarios "documentales" similares en tu código? Por ejemplo, en un file llamado Helper.cs: /* * Filename: Helper.cs * Author: Will Johansson * Created: 7/1/2010 * Purpose: Internal helper functionality […]

Palabra key de Subversion para nombre de file

Fondo El cliente solicita que todos los files fuente incluyan lo siguiente en el encabezado: File: filename.ext Problema Por lo que puedo decir, Subversion ofrece las siguientes palabras key : Carné de identidad Rdo Revisión Fecha LastChangedDate LastChangedRevision Autor LastChangedBy HeadURL URL De esas palabras key que contienen el nombre del file, todas contienen más […]

¿Dónde está el svnbook para la última versión de Subversion (1.9.4)?

El sitio oficial svnbook contiene versiones en línea del libro para 1.7 y para la versión "nocturna" 1.8. No estoy seguro de cómo 1,8 count como todas las noches cuando existe 1.9.4, pero lo que sea 🙂 ¿Dónde puedo encontrar una versión en línea del svnbook para la última versión de Subversion (1.9.4)?

Cómo usar Subversion con HelpNDoc

Estoy escribiendo una documentation para un proyecto que involucra a múltiples desarrolladores. Usamos Subversion (SVN) para trabajar en nuestra base de código. Escribí el primer borrador del documento de documentation utilizando HelpNDoc , que me gusta por la buena vista de tree y fácil de usar; el problema es que hay un único file, por […]

Actualice la documentation personalizada de Matlab periódicamente

He agregado una nueva pestaña de ayuda al documento de ayuda de Matlab existente. Antes de agregar, he convertido mis files de ayuda a .html que se colocan en el server de subversión. Luego, he vinculado estos files al file de ayuda de matlab agregando la ruta svn a la ruta de los files de […]

Generar automáticamente documentation para confirmaciones en TortoiseSVN

Quiero encontrar una forma de generar documentation de una confirmación automáticamente. Estamos utilizando SVN y todos usamos TortoiseSVN como software de cliente. (La mayoría del código es C ++ y estamos usando Windows) Será suficiente si podemos extraer los siguientes datos relacionados con el compromiso en cada confirmación, Número de revisión Mensaje de logging Lista […]

¿Qué sistema de documentation usar para la guía del usuario?

Actualmente estoy tratando de encontrar un sistema de documentation (guía del usuario) que tenga las siguientes características: files de documentation en modo text (por lo que svn podría diff / merge) posibilidad de usar imágenes, tablas, references cruzadas y tablas de contenido exportar a pdf (o .doc / .odt) que respaldaría references cruzadas Probé el […]