软件开发 文档 质量

1 在撰写API文档时，如果某个API的性能（时间性能、内存性能）特别低，应该在文档里详细列出。如此做的好处是：

1.1 有助于客户在设计阶段，采用正确、高效的方案

1.2 对于开发这个API的team，可以减轻维护压力，明确责任。因为在文档里写明，就不是软件的bug