Skip to content

commitaGit/public-dev-docs

 
 

Repository files navigation

开发文档


备注: 这里只存放可以公开共享的、目前有效的技术文档,不要存放任何会议记录或具体项目相关的文档。比如包含有内部项目截屏、计划或人员信息的文档要存在内部私有库。

持续的、高质效的软件开发能力是现代企业的核心竞争力。多年实践让我们意识到以下几点事实:

  • 思想就是软件 Mind is software (老刘)
  • 切忌随波逐流 Only dead fish go with the flow (西谚)
  • 做人如果没有梦想,跟咸鱼有什么分别 Salted fish has no dream (星爷)
  • 管理的本质是激发善意和潜能 The essence of management is to inspire goodwill and potential(德鲁克)

用思想创造软件进而改变世界的程序员责任重大,任劳任怨。可是环顾四周,多数软件团队的研发能力相对计算机的巨大潜力和广泛的业务需求有巨大鸿沟,开发效率低,软件的质量令人忧伤。稍感安慰的是半个多世纪的编程历史积累了一些最佳实践(best practices)。遵守基于这些最佳实践的规则能大大改善程序员的工作效率。

出发点

软件开发有二个根本性原则:正确的业务逻辑与可维护性。

软件开发管理活动,如自动测试要求,代码标准,代码审核,文档标准,github 工作流,需求工作流程,设计工作流程,开发环境配置等等都是基于这二个原则来展开。我们明白这些流程、标准、模版不是限制,任何规则都可以定制,目的是让整个开发过程自动化和标准化,从而让开发人员把精力放在最关键的创造性工作中。

高效工作来自我高标准驱动与合作精神。

文档的创建和维护

可以和所以开发者共享的、可以标准化的流程和最佳实践都存放这里。所有的工作都必须符合流程规则要求。如果规则或最佳实践不再适用,要先更新文档再按新流程执行。更新流程和最佳实践是所有开发人员的责任。

所有目录都有一个README.md说明文件。这个文件描述了目录下的所有文件并保持更新。当目录下的文件和文件夹超过十个时,需要按分类创建子目录。

所有文件的创建和更新需要创建 PR 和通过 Review。然后通知所有相关人员按新规则执行。不影响软件开发活动的简单的笔误更正和内容改善可以直接提交。

文档统一采用 Markdown 格式。建议采用 VS Code 并用 markdownlint来保证 markdown 文件风格的一致性。 v

文档说明

About

develop docs.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published