Preguntas etiquetadas con documentation

Estoy tratando de documentar una pieza de software que escribí en detalle. Un SAS tiene un nivel demasiado alto y no cubre la API. Encontré varios ejemplos de una SDS en línea, pero no veo una tendencia en su formato. Me pregunto si hay algunas pautas generales para escribir una …

8 documentation  api  uml  design 

Actualmente estoy trabajando en una implementación establecida en JavaScript. Esto debería simular genéricos como se conoce de Java o C #. Necesito una versión mutable de eso (permite agregar / eliminar valores establecidos) y una inmutable. Mi firma de constructor se ve así: new GenericSet( 'number', [ 10, 20, 30 …

8 javascript  documentation 

¿Cuál sería una buena alternativa a la documentación en línea de Java, es decir, puede uno tener un archivo de documentos separado de alguna manera asignado a un archivo fuente de Java? Nunca me han gustado las grandes secciones de comentarios llenas de código.

8 java  documentation  javadocs 

Soy nuevo en Django. He encontrado las guías de temas oficiales https://docs.djangoproject.com/en/1.3/ un excelente lugar para aprender. Pero ahora estoy en un lugar donde necesito una referencia rápida para ver qué métodos tiene un objeto, qué argumentos toma, qué devuelve, etc., como los documentos de Python o los documentos de …

8 django  documentation 

Cerrada . Esta pregunta necesita estar más centrada . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que se centre en un problema solo editando esta publicación . Cerrado hace 2 años . Estoy en medio de la coproducción de un documento de "enfoque de …

8 development-process  documentation  team 

¿Me puede recomendar una buena plantilla de plan de prueba para un equipo de prueba ágil? Sé que hay plantillas para probar en la web y ya he visto algunas encontradas por los motores de búsqueda, pero realmente podría usar algo liviano y algo que ya haya sido probado por …

8 testing  documentation 

Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 4 años . ¿Qué tan útil es medir puntos de función ? Usamos …

8 project-management  documentation 

Cerrada . Esta pregunta está basada en la opinión . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que pueda ser respondida con hechos y citas editando esta publicación . Cerrado hace 5 años . Mi equipo recientemente heredó un proyecto de un equipo donde …

8 documentation  team  exception-handling  coding-style 

Actualmente estoy trabajando en un proyecto, donde tengo que analizar los requisitos de dos sistemas de TI dados, que usan la computación en la nube, para una API en la nube. En otras palabras, tengo que analizar qué requisitos tienen estos sistemas para una API en la nube, de modo …

8 documentation  api 

Cerrado. Esta pregunta está fuera de tema . Actualmente no está aceptando respuestas. ¿Quieres mejorar esta pregunta? Actualice la pregunta para que sea sobre el tema de Software Engineering Stack Exchange. Cerrado hace 4 años . Recientemente me dieron la tarea de crear un documento del plan de implementación. Cuando …

8 project-management  documentation 

Un colega mío estuvo una vez en un seminario sobre desarrollo ágil, donde escuchó que es posible usar pruebas unitarias como documentación técnica. Algo así como usar pruebas unitarias como un ejemplo de cómo usar la clase. Una búsqueda rápida en Google proporcionó TDD y documentación , lo que demuestra …

8 agile  unit-testing  documentation  tdd 

He desarrollado algunas bibliotecas cuantitativas en C # donde es importante comprender no solo la información clásica que acompaña a los comentarios XMLDoc (que contiene información básica con la firma del método) sino también las fórmulas matemáticas que se utilizan dentro de los métodos. Por lo tanto, me gustaría poder …

8 documentation  documentation-generation 

Estoy trabajando en un informe que necesita explicar en términos no técnicos los efectos de un error acumulativo y por qué es importante usar cálculos absolutos. Definición de 'error acumulativo' de dictionary.com : un error que aumenta gradualmente en grado o importancia durante una serie de mediciones o cálculos; un …

8 documentation  terminology  management