场景：
假设我的团队正在开发一个软件项目,一个类似Fany-WordPad的应用程序,它有一个名为Fancy-Word-Art的功能(就像MS Office的word Art)一样.现在我写了主窗口的代码(在.Net中使用WPF,或者在Java中使用Window Builder,无论使用哪种工具/语言).
现在,如果我的同事海绵宝宝正在撰写Word-Art部分,那么我该怎么告诉他用什么函数/ Api来画我的窗口？即如何让SpongeBob先生知道他需要调用GetWindow()方法来获取对图面的引用,他需要传递的参数等等？
我希望我在这里很清楚这是程序吗？
步骤2：编写GetWindow()方法,使其与项目的其余部分工作良好
步骤2：现在使用GetWindow()方法的方法参数/数据类型要求将您的Intranet上的wiki放在一起,或者使用Doxygen / Confluence,如下所示
步骤3：现在,你的同事海绵宝宝头痛如何找到如何在我的窗口上画他的文字.
这只是不正确的声音..拥有大量的功能,海绵宝宝的生活将是艰难的,就像我的一样.我们两个人通过文件翻阅找到正确的职能来完成我们的工作.如果我将GetWindow()更改为GetWindow(字符串标题),那怎么办？现在我如何逐字地告诉可怜的海绵宝宝他需要重做他的代码.
我在这里遗漏了什么吗？请分享您的经验,您如何在现实世界的软件屋环境中解决这个问题？如果您的开发人员在下表中,您是否真的向他们展示了如何在遇到困难时执行某种方法,或者如何处理这种情况？
谢谢
谢谢
解决方法
当然,您可能会记录您的代码的一些里程,但如果您真正正确地编写系统,您的客户将永远不会看到您的代码. (对于客户来说,不一定在“支付您的服务”意义上).
这是良好做法和SOA的基础,所以你应该放弃“自我记录代码”的方法.
功能/方法/属性/无论什么具有价值的字母列表,一旦客户端“得到它”,但直到那时,它不是立即有用的.
所以让你不得不展示你的创作.给出一堆立即有用的例子,证明你所设想的那种事情.确保你有一个简单的例子,演示其基本形式的每个功能,与系统的其余部分(太多的必要的交互,你可能还没有一个干净的系统)的最小的交互.
一旦你有了,把它放在一个维基,并鼓励你的用户增强它.考虑使用像Stack-Overflow一样平台的交互式的东西. MSDN是一个很好的模式,但他们的例子经常吸吮而且缺乏语境.您可能比使用整个.NET框架更为紧迫和具体的用途.对您的示例/文档的问题和更新的早期回应将确保您的消息在重要的早期阶段得以实现.这将帮助您的文档负担快速地通过照顾您的客户并给他们有用的实际帮助.
希望有帮助.
