Skip to content

commitaGit/public-dev-docs

Repository files navigation

开发规则与文档

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

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

管理我们的不是这些条条框框和任何经理,是自我高标准驱动与合作精神带来高效产出。

文档结构

对全体有用的放在根目录,超过十个之后在建立相关分类目录。

第一层可以有前端,后端,需求,设计。

文档格式

统一采用 Markdown 格式。

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

About

develop docs.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published