escribir documentos
1. Por qué los programadores son reacios a escribir documentos
Hay muchas razones. He resumido algunos puntos: 1. El miedo a molestar a los programadores ha estado en mi corazón desde el principio. El día que comencé, enterré una semilla de programación, pensando que los programadores son programadores y aquellos que manejan computadoras, y los programas lo son todo para los programadores.
Ya sea que esté escribiendo documentación antes de programar o escribiendo documentación después de programar. Todos piensan que escribir documentación es molesto.
1) Hay demasiados tipos de documentos. Cuanto más formal, mejor.
La idea de escribir tantos documentos hace que a un programador le dé vueltas la cabeza. 2) Los requisitos de redacción de documentos no son bajos.
Existen requisitos de formato y requisitos de contenido. También debe dibujar varios diagramas de flujo, diagramas esquemáticos, diagramas de relaciones, diagramas de interfaz, completar varias instrucciones del formulario y recopilar diversa información. Aunque no hay contenido técnico, lleva más tiempo que la programación y es posible que no esté bien escrito.
3) En una empresa de desarrollo normal, generalmente se requieren una serie de documentos de cambio para un cambio. Cuando los cambios están en curso, sólo es importante la documentación del cambio final.
Cuando no sabemos si el documento actual es el último, somos reacios a escribir documentos que puedan ser reemplazados por documentos posteriores. 4) Después de escribir el documento, las personas que lo utilizan seguirán pidiendo detalles, y estas consultas a menudo hacen que la gente colapse.
Esto se debe a que es difícil escribir documentación sobre la que no todos puedan hacer preguntas. 2. Falta de tiempo En muchos casos, los programadores se encuentran en un estado de "tiempo limitado y tareas pesadas".
Impulsados por el afán de obtener resultados de programación, los programadores se centran en la programación, ansiosos por cambiar cada minuto. ¿Cómo pueden tener la idea y el tiempo para escribir el documento primero y luego programar? Incluso si tienen la idea de escribir el programa primero y luego documentarlo, una vez que completen un programa, inmediatamente se apresurarán al segundo programa. Como resultado, la redacción de documentos sólo se puede realizar en las últimas etapas del desarrollo del proyecto.
Si realmente escribe documentos, el tiempo que dedica a escribir documentos ya ocupará tiempo de programación y su trabajo de programación no se completará. 3. La importancia de no utilizar documentación en realidad es diferente para diferentes objetos.
Si dices que los documentos son inútiles, inmediatamente alguien te ahogará con saliva, e inmediatamente sacará a alguien que diga que los documentos son importantes e indispensables. Lo único que no me atrevo a decir es "Creo que los documentos son importantes".
Esto, a su vez, muestra que la utilidad de los documentos es diferente para distintas personas. Para programadores, siempre que puedan programar el programa.
Muchos programadores todavía escriben programas sin escribir documentos. En sus mentes, no importa si no escriben documentos. Si programa según documentos, debe asegurarse de que los documentos sean correctos e inalterables.
De hecho, la documentación no es tan rápida como la programación, y la programación no es tan rápida como el cambio. Los requisitos y el código cambiantes hacen que la documentación sea como una hoja de papel obsoleta. En realidad, algunos documentos se convierten en un resumen después del desarrollo del proyecto y no tienen ningún efecto sobre el desarrollo en sí. Simplemente conservan una forma existente para satisfacer las necesidades de diversas especificaciones.
En este caso, la documentación no tiene valor práctico, por lo que incluso si el programador la escribiera, no tendría ningún efecto. Especialmente después de que el proyecto se puso en producción, después de varias actualizaciones, los documentos originales ya no coincidían con la situación real, y las actualizaciones de los documentos y la coherencia del sistema eran aún más difíciles de controlar.
4. Ningún beneficio. Dado que creemos que la programación es la forma correcta, escribir documentos para programadores es un trabajo adicional y auxiliar. Por supuesto, los beneficios de la documentación se reflejan más en las empresas de software, las unidades, los usuarios de software y los programadores posteriores. Es bueno que "los predecesores planten árboles y las generaciones futuras disfruten de la sombra".
Por eso los programadores son reacios a escribir documentación. ¿Qué importancia tiene la documentación? Algunas personas lo han elevado al nivel de "copiar la mente del programador". Algunas personas incluso dicen que después de que los programadores se vayan, siempre que haya documentos, la empresa de software puede contratar nuevas personas y la empresa seguirá funcionando.
En este caso, ¿los programadores que son naturalmente inteligentes escribirán documentos con claridad? 5. No saber escribir Desde la perspectiva de la escritura en sí, redactar un documento no es una tarea fácil. Los documentos tienen formato de documento y requisitos de redacción.
A la gente hoy en día sólo le gusta hablar con la boca. No mucha gente sabe escribir, y mucho menos escribir artículos. Por lo tanto, escribir documentos también requiere aprendizaje y formación teórica, y requiere acumulación diaria de escritura.
Cuando a algunos programadores se les pide que escriban documentos, a menudo le responderán: "¿Cómo escribirlo? No sé cómo". No te culpo si no puedes escribirlo. Si no lo aprendes, lo harás con confianza. Si dices que no, es tu culpa.
¿Son "idiotas" aquellos que saben escribir documentos? ¿No entienden el valor del trabajo duro? Cuando un hombre expresa su amor por una mujer que le gusta y necesita una carta de amor para expresar su amor, ¿no sabría escribir una carta de amor? Incluso si no sabe escribir, definitivamente superará todas las dificultades y peligros para escribirlo. Esta es su decisión subjetiva. Si los programadores subjetivamente quieren escribir documentación, ¿por qué deberían preocuparse por eso? ¿Por qué tienes miedo de no tener tiempo? ¿Por qué tienes miedo de que el documento sea inútil? ¿Por qué tienes miedo de no poder escribir? Estos miedos son en realidad excusas.
Un programador verdaderamente excelente no sólo debe ser un maestro en programación, sino también un maestro en la redacción de documentos. La razón por la que a los programadores realmente no les gusta escribir documentos es que los documentos son para que otros los vean, no para ellos mismos.
Si desea que a los programadores les guste escribir documentos, debe mejorar el conocimiento y el dominio de los programadores, o recompensar a los programadores que escriben documentos. Depender de los sistemas y la administración para permitir que los programadores escriban documentos solo puede ser un inconveniente profesional.
Cuando un día la redacción de documentos se convierta en un puesto profesional y los programadores y el personal de documentación estén separados, los programadores se centrarán en leer documentos y escribir código, y el personal de documentación tomará esto como una carrera y se centrará en escribir documentación. Recibe tu pago. No hablaremos más de esto.
Esta división del trabajo debe ser la tendencia en el futuro. Algunas grandes empresas o empresas con gestión estandarizada ya cuentan con dicha división del trabajo.
Lo que pasa es que los departamentos de TI de muchas pequeñas y medianas empresas de software o empresas e instituciones aún no se han profesionalizado hasta este punto. A los programadores no les gusta escribir documentos, tal vez eso signifique que no quieren asumir demasiados roles.
En cualquier caso, como programador (especialmente si quieres ser un excelente programador), debes aprender a escribir documentos y apreciarlos. Le guste o no, debería poder avanzar y retroceder ante varios problemas con su documento.
Se puede decir que los programadores que no pueden escribir documentos ni apreciarlos no están calificados para decir "No me gusta escribir documentos". 2. ¿Cuáles son los requisitos para un ingeniero de documentación de TI?
Soy ingeniero de documentación. En términos de requisitos técnicos
1. Requiere su capacidad para expresar palabras. Después de todo, a menudo necesita "escribir" el documento usted mismo y los métodos de expresión son diferentes para diferentes objetos. Es necesario descubrir las habilidades de escritura, los detalles del texto, etc. Lo principal es que la introducción sea clara, precisa y fácil de entender, específica y sin muchas palabras.
2. Se requiere dominio en el manejo de herramientas de MS, principalmente Word, que se utiliza principalmente para escribir documentos, seguido de Excel y PPT, que son menos útiles que Word. No significa que tengas que ser competente, muchas cosas se pueden aprender lentamente a través del trabajo real.
3. Es necesario comprender los productos de la empresa, como la arquitectura del sistema del producto, los principales procesos de trabajo y las funciones y principios de cada componente. Dado que la redacción de documentos está directamente relacionada con estos, es necesario dominarlos lo antes posible.
4. Sigue aprendiendo por tu cuenta. Aunque los ingenieros de documentación no están tan cansados como los ingenieros de pruebas y de I+D, aún necesitan seguir aprendiendo. Aprende inglés ya que es posible que necesites un traductor. Aprenda algunos conocimientos básicos de la industria de TI, compre algunos libros y léalos. Aprenda a utilizar software relacionado con el producto, como comandos de Linux, etc. Si se trata de código de programa, es necesario aprender esos lenguajes de programación, pero es sólo arquitectónico y no es necesario comprender cada línea de declaraciones.
Eso es todo.
Cualquier profesión debe tener integradas sus propias capacidades e intereses, para que puedas ser feliz en el trabajo y vivir feliz. Te deseo buena suerte 3. Estoy aprendiendo TI (cómo escribir una novela en línea si quieres escribirla)
La primera forma es guardar tu texto en un documento de Word y publicarlo en la publicación correspondiente. bar
Por ejemplo, las novelas románticas se pueden publicar en bares de novelas románticas, pero generalmente se escriben por diversión
La segunda está en el sitio web de novelas
A mejor es el sitio web de lectura de novelas Qidian Jinjiang
Si es una novela del campus, puedes ir a Juxing, pero Juxing está muy estancado
Si la escritura es más ligera y madura. , puedes ir a Huahuo
Pero este tipo de métodos generalmente deben revisarse antes de que puedan publicarse. El primer método puede ser publicado por usted mismo.
El segundo método es más. una prueba de escritura
Si no quieres que lo revisemos, puedes publicarlo en la barra de publicaciones, pero lo mismo ocurre con las respuestas de tus amigos en el foro. Un tipo de revisión
. p>
El segundo tipo es fácil de quedarse corto si la escritura es lenta. Es posible que hayas escrito mucho pero no hayas aprobado la revisión╮（╯▽╰）╭
Pero esto en ambos casos. Lo mejor es guardar el texto en un documento de Word. Aunque los sitios web novedosos generalmente permiten a los escritores guardar los manuscritos, es más seguro almacenarlos en el documento. 4. Requisitos para que empresas conocidas contraten ingenieros de redes.
Los requisitos de los ingenieros de redes para cada empresa y puesto de trabajo son diferentes, generalmente divididos en junior, intermedio y senior. Los requisitos del trabajo junior son generalmente: título universitario o superior en informática y carreras relacionadas. protocolos de red, tener cierta comprensión de la red; tener un cierto nivel de capacidad de lectura en inglés y comprensión básica del servidor
Los niveles intermedio y avanzado requieren más de dos años de experiencia laboral. los requisitos laborales también son más altos; tener experiencia en mantenimiento de redes o trabajo relacionado y dominar la construcción de diversos entornos de red (LAN/WAN); tener una base técnica sólida; dominar los conocimientos básicos de redes de datos; tener sólidas capacidades de mantenimiento y resolución de problemas de redes; estar familiarizado con las herramientas de prueba de red y conocimientos relacionados con la seguridad del host, y ser capaz de configurar hábilmente los firewalls convencionales, etc. Sin embargo, los requisitos laborales de cada empresa deben estar determinados por los requisitos laborales específicos de la empresa 5. Por qué los programadores son reacios a escribir documentos
Hay muchas razones. He resumido algunos puntos: 1. Miedo a los problemas desde el día en que comenzaron, los programadores han enterrado una semilla de programación en sus corazones. Piensan que los programadores son programadores y se ocupan de las computadoras. Los programas lo son todo para los programadores.
No importa dónde estén, son programadores, ya sea que escriban documentación antes o después de programar. es molesto.
1) Hay demasiados tipos de documentación. Cuanto más formal, mejor.
La idea de escribir tantos documentos hace que a un programador le dé vueltas la cabeza. 2) Los requisitos de redacción de documentos no son bajos.
Existen requisitos de formato y requisitos de contenido. También debe dibujar varios diagramas de flujo, diagramas esquemáticos, diagramas de relaciones, diagramas de interfaz, completar varias instrucciones del formulario y recopilar diversa información. Aunque no hay contenido técnico, lleva más tiempo que la programación y es posible que no esté bien escrito.
3) En una empresa de desarrollo normal, generalmente se requieren una serie de documentos de cambio para un cambio. Cuando los cambios están en curso, sólo es importante la documentación del cambio final.
Cuando no sabemos si el documento actual es el último, somos reacios a escribir documentos que puedan ser reemplazados por documentos posteriores. 4) Después de escribir el documento, las personas que lo utilizan seguirán pidiendo detalles, y estas consultas a menudo hacen que la gente colapse.
Esto se debe a que es difícil escribir documentación sobre la que no todos puedan hacer preguntas. 2. Falta de tiempo En muchos casos, los programadores se encuentran en un estado de "tiempo limitado y tareas pesadas".
Impulsados por el afán de obtener resultados de programación, los programadores se centran en la programación, ansiosos por cambiar cada minuto. ¿Cómo pueden tener la idea y el tiempo para escribir el documento primero y luego programar? Incluso si tienen la idea de escribir el programa primero y luego documentarlo, una vez que completen un programa, inmediatamente se apresurarán al segundo programa. Como resultado, la redacción de documentos sólo se puede realizar en las últimas etapas del desarrollo del proyecto.
Si realmente escribe documentos, el tiempo que dedica a escribir documentos ya ocupará tiempo de programación y su trabajo de programación no se completará. 3. La importancia de no utilizar documentación en realidad es diferente para diferentes objetos.
Si dices que los documentos son inútiles, inmediatamente alguien te ahogará con saliva, e inmediatamente sacará a alguien que diga que los documentos son importantes e indispensables. Lo único que no me atrevo a decir es "Creo que los documentos son importantes".
Esto, a su vez, muestra que la utilidad de los documentos es diferente para distintas personas. Para programadores, siempre que puedan programar el programa.
Muchos programadores todavía escriben programas sin escribir documentos. En sus mentes, no importa si no escriben documentos. Si programa según documentos, debe asegurarse de que los documentos sean correctos e inalterables.
De hecho, la documentación no es tan rápida como la programación, y la programación no es tan rápida como el cambio. Los requisitos y el código cambiantes hacen que la documentación sea como una hoja de papel obsoleta. En realidad, algunos documentos se convierten en un resumen después del desarrollo del proyecto y no tienen ningún efecto sobre el desarrollo en sí. Simplemente conservan una forma existente para satisfacer las necesidades de diversas especificaciones.
En este caso, la documentación no tiene valor práctico, por lo que incluso si el programador la escribiera, no tendría ningún efecto. Especialmente después de que el proyecto se puso en producción, después de varias actualizaciones, los documentos originales ya no coincidían con la situación real, y las actualizaciones de los documentos y la coherencia del sistema eran aún más difíciles de controlar.
4. Ningún beneficio. Dado que creemos que la programación es la forma correcta, escribir documentos para programadores es un trabajo adicional y auxiliar. Por supuesto, los beneficios de la documentación se reflejan más en las empresas de software, las unidades, los usuarios de software y los programadores posteriores. Es bueno que "los predecesores planten árboles y las generaciones futuras disfruten de la sombra".
Por eso los programadores son reacios a escribir documentación. ¿Qué importancia tiene la documentación? Algunas personas lo han elevado al nivel de "copiar la mente del programador". Algunas personas incluso dicen que después de que los programadores se vayan, siempre que haya documentos, la empresa de software puede contratar nuevas personas y la empresa seguirá funcionando.
En este caso, ¿los programadores que son naturalmente inteligentes escribirán documentos con claridad? 5. No saber escribir Desde la perspectiva de la escritura en sí, redactar un documento no es una tarea fácil. Los documentos tienen formato de documento y requisitos de redacción.
A la gente hoy en día sólo le gusta hablar con la boca. No mucha gente sabe escribir, y mucho menos escribir artículos. Por lo tanto, escribir documentos también requiere aprendizaje y formación teórica, y requiere acumulación diaria de escritura.
Cuando a algunos programadores se les pide que escriban documentos, a menudo le responderán: "¿Cómo escribirlo? No sé cómo". No te culpo si no puedes escribirlo. Si no lo aprendes, lo harás con confianza. Si dices que no, es tu culpa.
¿Son "idiotas" aquellos que saben escribir documentos? ¿No entienden el valor del trabajo duro? Cuando un hombre expresa su amor por una mujer que le gusta y necesita una carta de amor para expresar su amor, ¿no sabría escribir una carta de amor? Incluso si no sabe escribir, definitivamente superará todas las dificultades y peligros para escribirlo. Esta es su decisión subjetiva. Si los programadores subjetivamente quieren escribir documentación, ¿por qué deberían preocuparse por eso? ¿Por qué tienes miedo de no tener tiempo? ¿Por qué tienes miedo de que el documento sea inútil? ¿Por qué tienes miedo de no poder escribir? Estos miedos son en realidad excusas.
Un programador verdaderamente excelente no sólo debe ser un maestro en programación, sino también un maestro en la redacción de documentos. La razón por la que a los programadores realmente no les gusta escribir documentos es que los documentos son para que otros los vean, no para ellos mismos.
Si desea que a los programadores les guste escribir documentos, debe mejorar el conocimiento y el dominio de los programadores, o recompensar a los programadores que escriben documentos. Depender de los sistemas y la administración para permitir que los programadores escriban documentos solo puede ser un inconveniente profesional.
Cuando un día la redacción de documentos se convierta en un puesto profesional y los programadores y el personal de documentación estén separados, los programadores se centrarán en leer documentos y escribir código, y el personal de documentación tomará esto como una carrera y se centrará en escribir documentación. Recibe tu pago. No hablaremos más de esto.
Esta división del trabajo debe ser la tendencia en el futuro. Algunas grandes empresas o empresas con gestión estandarizada ya cuentan con dicha división del trabajo.
Lo que pasa es que los departamentos de TI de muchas pequeñas y medianas empresas de software o empresas e instituciones aún no se han profesionalizado hasta este punto. A los programadores no les gusta escribir documentos, tal vez eso signifique que no quieren asumir demasiados roles.
En cualquier caso, como programador (especialmente si quieres ser un excelente programador), debes aprender a escribir documentos y apreciarlos. Le guste o no, debería poder avanzar y retroceder ante varios problemas con su documento.
Se puede decir que los programadores que no pueden escribir documentos ni apreciarlos no están calificados para decir "No me gusta escribir documentos". 6. Cómo redactar buenos documentos de producto
En términos generales, los documentos de producto se dividen en dos tipos: documentos de requisitos del producto y documentos de uso del producto. Los documentos de requisitos del producto están orientados principalmente a los desarrolladores y diseñadores de productos. Se espera que los desarrolladores reales del producto comprendan los detalles del producto para que el producto desarrollado pueda cumplir con las expectativas de los documentos de uso del producto iniciales; a los usuarios, para que puedan Dominar el uso de las funciones del producto a través de la documentación del producto, que es lo que a menudo llamamos ayuda para el uso del producto, si no comprende el objetivo del documento, la redacción a menudo no logrará el efecto deseado; La redacción profesional de documentos como esta es bastante universal; dominar las habilidades de redacción de este tipo de redacción es una muy buena habilidad, especialmente para nosotros, los profesionales de TI. En los últimos dos años de mi carrera, el autor se ha ocupado de muchos de estos documentos y me gustaría compartir aquí algunas experiencias con ustedes.
1. El objeto debe estar claro.
Como se mencionó al principio, la importancia de tener claro el objeto al que está orientado el documento. Para diferentes objetos, debes usar diferentes ideas de escritura para tratarlos y tratar de pensar desde la perspectiva de la otra parte tanto como sea posible. ¿Qué necesita ver? ¿Qué contenido le resulta útil? ¿Cómo se lo explico? Para los diseñadores de productos, lo que necesitan saber es el estilo, la interfaz, la interacción, etc. del producto. Para los codificadores reales, se centran en la viabilidad del producto y su contenido debe centrarse en los detalles funcionales y el procesamiento interno del producto. Por tanto, el objeto al que está orientado el documento determina la función y el contenido del documento. Se puede determinar el público objetivo del documento.
2. La organización debe ser clara.
Una organización clara del documento no solo hace que su documento se vea más fluido, sino que también permite que los lectores lo entiendan claramente. Por lo tanto, antes de comenzar a escribir, debe saber en qué módulos principales se divide aproximadamente el contenido de su documento, cuántos submódulos se subdividen en los módulos y luego completar el contenido detallado según el esquema. En mi experiencia anterior, a menudo pienso detenidamente en el documento durante varios días antes de escribirlo. Siempre espero pensar detenidamente todas las cuestiones con claridad antes de escribirlo. Este es un mal movimiento para un escritor. De hecho, las cosas que rondan por tu mente no son tan intuitivas como verlas en papel. Una vez que aparece el esquema, es mucho más eficiente agregarlo y modificarlo una y otra vez que simplemente seguir escribiendo. Para escribir, la parte más difícil es empezar.
3. La lógica debe ser rigurosa.
Los documentos de producto son diferentes a los tipos de documentos que solemos escribir. Los requisitos para el rigor de la narrativa del contenido son muy estrictos. Debido a que su documento no es solo su comprensión del proyecto y producto, también debe usarse como un medio de colaboración para que otros colegas lo utilicen al mismo tiempo, y también puede convertirse en una guía para la dirección del trabajo de otros colegas. Por tanto, el rigor es imprescindible. Por lo tanto, bajo la premisa de que el documento está claramente organizado, es necesario considerar y pensar cuidadosamente en las posibles ambigüedades y partes faltantes del documento, y modificarlo repetidamente. En el contexto del trabajo coordinado de todos, les resulta imposible considerar todas las cuestiones con claridad. Por lo tanto, los colegas a menudo señalan los defectos y lagunas en sus documentos.
Pero aún así deberías pensar más en ello en la etapa inicial para minimizar los problemas.
4. Utilice palabras profesionales
Una redacción profesional e inapropiada puede ayudarle a mejorar el profesionalismo de su documento y también puede ayudarle a mejorar la eficiencia y reducir la duplicación y los costos de comunicación innecesarios. Dado que es una industria, necesita estándares industriales. El uso de terminología profesional de la industria es un signo de profesionalismo. Esto no solo puede establecer rápidamente un entendimiento común con sus colegas, sino también hacer que otros piensen que usted es muy profesional. Creo que este tipo de colaboración entre colegas es eficiente. Por supuesto, para los principiantes, dominar el vocabulario profesional requiere leer más. Saber más sobre blogs especializados y conocer a más personas mayores y amigos será de gran ayuda tanto para escribir como para trabajar.
5. El formato debe estar estandarizado.
Para un profesional de la industria TI, un modelo de trabajo estandarizado y orientado a procesos es muy importante. Para documentos que deben ser manejados por otros o que deben archivarse, la estandarización del formato es un criterio importante para medir su nivel de profesionalismo. Por supuesto, cuando se trata de esta especificación, debes comprender qué tipo de especificación es antes de escribirla por primera vez. ¿Es una norma de la industria? ¿O es una norma interna de la empresa? Depende de tu empresa o proyecto. Para las grandes empresas, todo lo que tienen que hacer es leer documentos similares escritos por sus predecesores para comprender estas especificaciones. Para pequeñas empresas o nuevos proyectos, no existe ninguna documentación de producto similar hasta ahora. Lo único que tienes que hacer es seguir las especificaciones estándar más las características del proyecto y escribir con el mayor cuidado posible. Creo que gracias a sus esfuerzos, el documento que redacte se convertirá en un ejemplo y estándar de este tipo de documentos.
De hecho, ya sea un documento de requisitos del producto (PRD), un documento de planificación del producto o un plan de negocios, debemos trabajar duro y estudiarlo detenidamente. Después de todo, Internet en China solo se ha desarrollado durante más de diez años y muchos detalles aún no son muy profesionales. Para una persona pensante en Internet, sólo armando su mente y enriqueciendo sus habilidades podrá encontrar un mejor desarrollo profesional.