数据库以及API文档要求

1.首先记住文档优先级高于代码。 一个好的API文档,可以让人的思路瞬间清晰,让人看完文档就知道要实现什么功能,使用那些接口,以及接口的所需要的参数。 一个好的数据库文档,可以让人眼前出现数据库的全部样貌,出现数据库的数据基本类型,让人一眼就看的出来该数据库的设计,逻辑等。 2.数据库文档格式: 1.概念结构设计: 将表名规范化,让人一眼就知道这个表是干什么的, 2.逻辑结构设计(关系模型) 如:
相关文章
相关标签/搜索