• 北风一叶
    2019-03-11
    我之前的主管给我的建议是这样的:你就把用户假定为啥也不理解然后再去写文档,写出来的文档就是合格的

    作者回复: 这是一个好办法。经常地,我们看一些文档,觉得废话太多,大量的篇幅交代背景。其实,哪是为了照顾更多的用户。

    
     2
  • kelvin
    2019-04-03
    我提出要给服务的接口写wiki,但是领导说大家都不会维护,还不如直接问接口维护人。我觉得维护文档是大家不太习惯,但是长远来看是可以提高开发效率。

    作者回复: 直接问接口维护人的问题很多: 接口维护人不一定时刻都在;接口维护人不一定有那么多时间;接口维护人不一定记得那么多细节;我们不一定想要面对面地提问;面对面问问题的效率有可能更低(复杂的技术问题需要问答双方都花很多时间)。

    
     1
  • 空知
    2019-02-15
    微信和Github的示例都只是提供示例,但是一些前提概念没有说明下吧.

    作者回复: 嗯,引用的是快速入门部分。

    
     1
  • 丁丁历险记
    2019-10-14
    身为py coder 我内心纠结之处,一直觉得java 反人类,经常一个简单事搞的啰哩巴嗦的,一度认为再好的设计模式也救不了java 的不优雅。
    甚至看到java 的代码示例看着就浅意识排斥。
    现在技术到了瓶颈期,在反思如何改善这些观点,我可以不喜欢,但个人鲁棒性需要加强。
    
    
  • Sisyphus235
    2019-05-22
    用户指南就像是开发者的 PPT,一个好的产品还要有一个漂亮的展示才能有价值。

    例证丰富能快速上手实践的往往是好的用户指南,在写文档的时候,文字和代码以及例证交叉,再配合一些图效果比较好,另外使用总分的结构效果比较好
    
    
  • Lindroid
    2019-04-27
    今年我也在GitHub上添加了两三个开源库(主要是供自己使用),不得不说写好说明文档真的是不容易的,而且比起最初的编写,后期的维护也考验人。

    作者回复: 😊经久耐用的软件,成本基本都在维护上。

    
    
  • 秦凯
    2019-02-15
    个人理解是:接口规范应该更多的是描述接口为什么这么设计,而用户指南更多的是指导用户如何使用接口,阅读的群体和功能上有区别。

    作者回复: 在 Java SE里,接口规范一般不包括“为什么这么设计”的描述。

    
    
  • vector
    2019-02-08
    简单明了,考虑全面。佩服别人家的手册。
    
    
我们在线,来聊聊吧