你如何记录你工作的项目？

问题描述

我在哪里工作，我一直在做开发工作。我们通常处于一个我们总是忙于开发工作的位置，没有时间编写真正的维护者文档。我怀疑我的立场是独一无二的。

我的问题是，你/你的开发团队如何处理文件？

你去文档吗？你在项目结束时写文档吗？是否有独立的团队负责收集和撰写文件？您是否使用内部文档，如Javadoc评论或.NET的XML注释？

每个人都发现最有效的方式，并且如何计划实际写入时间？

解决方案

你有时间写单元测试吗？有用的日志记录？代码中的注释？

这些任务都是开发的一部分。您的时间表和时间估计应包括编写代码所需的时间，还包括测试代码，记录文档以及生成应用程序所涉及的所有时间。

所以是的，你随身携带文件。有关于应用程序如何与其依赖关系和其他系统进行交互的图表。包括关于设计决策，替代方法和未来计划的说明。确保生成操作文档 - 如何部署应用程序，如何解决问题等。

Where I work, I'm constantly doing development work. We're usually in a position where we're always busy doing development work with no time to write real maintainer documentation. I doubt my position is unique.

My question to everyone is, how do you/your development team handle documentation?

Do you document as you go? Do you write documentation at the end of the project? Is there a separate team of people who are solely responsible for gathering and writing documentation? Do you use inline documentation like Javadoc comments or .NET's XML comments?

What does everyone find to be the most effective, and how do you plan time to actually write it?

解决方案

Do you have time to write unit tests? What about useful logging? Comments in the code?

These tasks are all part of doing development. Your schedule and time estimates should include the time required not only for writing the code, but also for testing it, documenting it, and everything else involved in producing an application.

So yes, document as you go. Have diagrams about how the application interacts with its dependencies and other systems. Include notes about design decisions, alternative approaches, and future plans. Be sure to produce operational docs as well - how to deploy your application, how to troubleshoot, etc.

这篇关于你如何记录你工作的项目？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！