• Stars
    star
    347
  • Rank 118,248 (Top 3 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 5 years ago
  • Updated almost 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🥳🥳🥳🥳 a checklist & tool for new project setup for developer. 新项目检查清单及其工具。

New Project Checklist

Online Tools: https://phodal.github.io/new-project-checklist/

English

Focus on four dimensions:

  • Process, focusing on processes from permissions management, code acquisition, deployment, and code integration.
  • People, connecting stakeholders, third-party partners (out-of-organization), collaborative teams (within the organization), team members, and more.
  • Tech, including technical vision, documentation (documents), project code, technology stack, software library management, etc.
  • Business, covering the requirements of business features such as business vision, business needs, and cross-functional requirements.

Tech

0. Technology Vision

Description: In terms of technology, what are we pursuing?

1.Documentation

  • Path to Production
  • golive and release diary
  • other wikis and documentation
  • Development specification

Description: a good documentation should be versionable.

2.Architecture

  • system architecture diagram, such as C4Model mode
  • existing technology stacks and their relationships

3.Code base

  • setup guide.Which is README
  • architecture decision record. in docs/ard directory.
  • editor configuration and code style specification
  • mode and style guide
  • version manager branch pattern. GitFlow or Feature Branch of Master Flow.
  • commit message style. open source library style or business style

4.Security

  • test strategy.test layered, test pyramid.
  • test automation.

5.Project Evolution

  • Technical risk.Need to spike before project start.
  • future technology stack
  • system evolution plan

6. Security

  • security standard. Is safety more important, or is the experience more important?
  • data encrypt in the code.
  • code security.

7. Quality

  • project quality tracking.
  • visualization of code quality.
  • quality strategy.

Process

0. Project Process

  • Project's Roadmap? Such as project deadline, milestone, plan (with interation plan).
  • features's lifecycle. Such as Story card workflow in agile
  • How to communicate? Such as IM, Email and agile daily standup, remote meeting, Retro, etc.

1.Path to Development

  • development machine and network permission preparation and so on
  • code repositroy permission management
  • editor and related tool application setup

Note: different organizations have their own special situations, such as the opening of PC ports, network permissions, codebase permissions, etc., which require a certain process.

2.Path to Production

  • the process of golive's every step
  • related key people
  • the tools needed for each step
  • the process required for each step. such as quality assurance people & process, and golive process

Note: Path to Production in the code is just a description - [ ] for developers, and here's a more detailed explanation.

3.Path to Roll Off   Note: What do you need when you change a project?

People

1.Teammate

  • Who are you looking for each problem?
  • Team members' technical stack and level
  • How to bring everyone's skill level: Coach, Pairing, Teach
  • Project-independent technology, who can find "entertainment" together?
  • 1 to 1 Meetings

2.Stakeholders

  • Learn about each stakeholder (Level 1). As a developer, most of the time there is no direct communication with stakeholders.
  • Stay in communication with the stakeholders (Level 2). Proper communication can help the project to work better.

3.Cross-team collaboration

  • What are the relevant partners and who are the respective interfaces?
  • Team in same project or organizations.

4.Users

  • Who is the user? Are we in direct contact with them?
  • Feedback loop. How does a user's feedback become requirements?

Domain

0.Business Vision

Explanation: What are we doing, where are we going?

1.Business

  • Is there a list of requirements that are close to full? At a certain time (such as iterations), the demand should be stable.
  • How does demand go from verbal to to-do list? Is there an irregular problem in the middle?
  • How is the business changed?

2.Cross-functional requirements

  • Operational quality. Quality observed during system operation, such as security and ease of use
  • Evolution quality. Software system structure and quality related to the development process, such as software testability, maintainability, scalability, scalability, etc.

中文(Chinese)

关注于四个维度:

  • Process,关注于从权限管理、获取代码、部署上线、代码集成等的流程。
  • People,连接利益相关者、第三方合作伙伴(组织外)、协作团队(组织内)、团队成员等相关的人。
  • Tech,包含了技术远景、文档(文档即代码)、项目代码、技术栈、软件库管理等。
  • Business,涵盖了业务远景、业务需求、跨功能需求等业务相关功能的需求。

Tech

0. 技术远景

说明:在技术上,我们有什么追求?

1. 文档

  • Path to Production
  • 上线及发布日记
  • 项目相关的 wiki 和文档记录
  • 开发规范

说明:文档即代码——好的文档应该是版本管理的。

2. 架构

  • 系统相关的架构图,如 C4Model 方式描述
  • 现有的技术栈及其关系

3. 代码库

  • 搭建指南。即 README
  • 架构决策记录。放置在代码库的 docs/adr 目录中。
  • 编辑器配置和代码风格规范。
  • 模式和风格指南。
  • 分支管理模式。GitFlow 或者 master,或者 Feature Branch。
  • 代码提交风格。业务风格或者是开源软件风格?

4. 测试

  • 测试策略。测试层级, 测试金字塔。
  • 自动化测试。

5. 项目演进

  • 技术风险点。即需要提前 spike 调研的内容
  • 未来的技术栈
  • 系统的演进方案

6. 安全

  • 安全标准。安全更重要,还是体验更重要?
  • 代码中的数据加密。
  • 代码安全。

7. 质量

  • 项目质量跟踪。
  • 代码质量可视化。
  • 应用质量策略。

Process

0. Project Process

  • 项目的 Roadmap?项目 Deadline,关键时间节点,项目规划等。
  • 项目功能的生命周期。如敏捷中的故事卡工作流
  • 沟通方式?如 IM,邮件,还有敏捷的每日站会,远程会议,Retro 等

1. Path to Development

  • 开发机申请及网络等权限准备
  • 代码库权限管理
  • 编辑器和相关的工具申请

说明:不同的的组织包含自身特别的情况,如 PC 端口、网络权限、代码库权限等的开通都需要一定的流程。

2. Path to Production

  • 上线每一步的流程
  • 相关的关键人
  • 每一步所需要的工具
  • 每一步所需要的流程。如 QA 测试流程,上线流程

说明:代码中的 Path to Production 只是一份说明——针对于开发人员的,而这里的则需要一个更详细的说明。

3. Path to Roll Off

说明:换一个项目时,需要哪些东西?

People

1. 团队成员

  • 非技术问题找谁?
  • 团队成员的技术栈及水平
  • 每个人的技术水平,应该怎么带:Coach(教练式), Pairing(结对式), Teach(教学式)
  • 项目无关的技术,可以找谁一起“娱乐”?
  • 1 to 1 Meetings

2. 利益相关者

  • 了解各个相关者(Level 1)。如作为一个开发人员,大部分时间并不会和利益相关者有直接的沟通。
  • 和相关者保持沟通(Level 2)。适当沟通,可以帮助项目更好地进行。

3. 跨团队协作

  • 相关的合作方有哪些,各自的接口人是谁?
  • 同组织、项目下的其它团队。

4. 用户

  • 用户是谁?我们是否与他们直接接触?
  • 反馈环。一个用户的反馈是如何变成需求的?

Business

0. 业务远景

说明:我们在做什么,我们要去哪里?

1. 业务需求

  • 有没有接近全的需求列表。在一定的时间(如迭代内),需求应该是稳定的。
  • 需求是如何从口头到待办列表的?中间是不是存在不规范的问题
  • 业务是如何进行变更的?

2. 跨功能需求

  • 运行质量。在系统运作时观察到的质量,例如保安性及易用性等
  • 演进质量。软件系统结构及开发过程有关的质量,例如软件可测试性、可维护性、可扩展性、可伸缩性(scalability)等

License

Web based on https://github.com/thedaviddias/Front-End-Checklist See web/LICENSE in this directory.

Phodal's Idea

© 2019 A Phodal Huang's Idea. This code is distributed under the MIT license. See LICENSE in this directory.

More Repositories

1

github

GitHub 漫游指南- a Chinese ebook on how to build a good project on Github. Explore the users' behavior. Find some thing interest.
Rich Text Format
9,132
star
2

growth-ebook

Growth Engineering: The Definitive Guide。全栈增长工程师指南
HTML
7,688
star
3

awesome-iot

Awesome IoT. A collaborative list of great resources about IoT Framework, Library, OS, Platform
Python
4,042
star
4

ideabook

一个全栈增长工程师的练手项目集. A Growth Engineering Idea in Action.
HTML
3,729
star
5

migration

《系统重构与迁移指南》手把手教你分析、评估现有系统、制定重构策略、探索可行重构方案、搭建测试防护网、进行系统架构重构、服务架构重构、模块重构、代码重构、数据库重构、重构后的架构守护
Java
3,232
star
6

microfrontends

Micro-frontend Architecture in Action-微前端的那些事儿
3,012
star
7

prompt-patterns

Prompt 编写模式:如何将思维框架赋予机器,以设计模式的形式来思考 prompt
2,810
star
8

growth-in-action

全栈增长工程师实战
HTML
2,492
star
9

designiot

教你设计物联网系统。构建自己的Internet of Things 。
HTML
2,181
star
10

growth-ionic

[v2.0 DEPRECATED, please update to Growth 3.0] Growth - App to help you Be Awesome Developer & Awesome Hacker
TypeScript
2,159
star
11

ledge

Ledge —— DevOps knowledge learning platform. DevOps、研发效能知识和工具平台,是我们基于在 ThoughtWorks 进行的一系列 DevOps 实践、敏捷实践、软件开发与测试、精益实践提炼出来的知识体系。它包含了各种最佳实践、操作手册、原则与模式、度量、工具,用于帮助您的企业在数字化时代更好地前进,还有 DevOps 转型。
TypeScript
2,130
star
12

fe

《我的职业是前端工程师》 - Ebook:I'm a FrontEnd Developer
HTML
2,004
star
13

serverless

Serverless 架构应用开发指南 - Serverless Architecture Application Development Guide with Serverless Framework.
HTML
1,729
star
14

developer

developer roadmap. use growth https://github.com/phodal/growth replace this
Makefile
1,712
star
15

growth

Growth 3.0 with React Native - an app to help you to be Awesome Developer
JavaScript
1,231
star
16

aigc

《构筑大语言模型应用:应用开发与架构设计》一本关于 LLM 在真实世界应用的开源电子书,介绍了大语言模型的基础知识和应用,以及如何构建自己的模型。其中包括Prompt的编写、开发和管理,探索最好的大语言模型能带来什么,以及LLM应用开发的模式和架构设计。
Rust
1,191
star
17

iot

IoT, 这是一个最小Internet of Things ,一个Internet of Things相关的毕业设计产生的一个简化的物联网系统。 。
Python
1,129
star
18

booktree

A Book Tree
JavaScript
1,044
star
19

skilltree

Web Developer 技能树
JavaScript
952
star
20

ideas

Ideas of Phodal
940
star
21

articles

Article Publish in Wechat & Toutiao
Makefile
911
star
22

toolbox

Phodal's Toolbox
HTML
906
star
23

coca

Coca is a toolbox which is design for legacy system refactoring and analysis, includes call graph, concept analysis, api tree, design patterns suggest. Coca 是一个用于系统重构、系统迁移和系统分析的工具箱。它可以分析代码中的测试坏味道、模块化分析、行数统计、分析调用与依赖、Git 分析以及自动化重构等。
Go
881
star
24

mooa

Mooa 是一个为 Angular 服务的微前端框架。A independent-deployment micro-frontend Framework for Angular from single-spa.
TypeScript
841
star
25

clean-frontend

Clean Frontend Architecture:整洁前端架构
TypeScript
805
star
26

tangping

躺平即正义。Nothing is true, everything is permitted
708
star
27

repractise

RePractise
HTML
699
star
28

sherlock

Skill Tree Sherlock
JavaScript
675
star
29

lan

Internet of Things Server Layer with CoAP, WebSocket, MQTT, HTTP Protocol.
JavaScript
559
star
30

eks

嵌入式知识总汇 Embedded Knowledge Structure
511
star
31

weapp-quick

微信小应用示例代码
JavaScript
474
star
32

ebook-boilerplate

A Markdown convert to Ebook ➡️ html、mobi、epub、pdf、rtf Template
CSS
426
star
33

quake

Quake is a knowledge management meta-framework for geeks. Use meta-data + Transflow to CRUD data, Git + markdown to management content, Web Component for frontend-custom. Quake 是面向极客的知识管理元框架。
Rust
423
star
34

growth-roadmap

Growth APP' Project, Links, Blogs, Books, Resources
CSS
407
star
35

aofe.code

《前端架构:从入门到微前端》源码,code for Architecture of Frontend
JavaScript
370
star
36

awesome-iot-document

Awesome IoT Documents. [Deprecated] Internet of Things Document
340
star
37

phodit

Phodal's markdown/ebook editor with MicroFrontend & Web Components
TypeScript
330
star
38

oculus-nodejs-threejs-example

Oculus + Node.js + Three.js 打造VR世界
JavaScript
296
star
39

lowcode

Low-code platform design rule
275
star
40

weapp-webdemo

A Hack of Weapp Framework
JavaScript
268
star
41

dx-book

《开发者体验:探索与重塑》电子书。book of research and refactoring in developer experience (WIP)
SCSS
259
star
42

evolution

Growth:增长工程师修炼之道——读书、写作、编程
HTML
244
star
43

licenses

OpenSource License Explains
HTML
243
star
44

adr

Architecture Decision Records in Node.js with Reporter, supported Windows, GNU/Linux, macOS - 轻量级架构决策记录工具
TypeScript
240
star
45

cloud-dev

云研发,是一种生于云上的闭环 + 代码化的软件开发方式。它可以让业务人员、开发人员、运营人员等在同一个云端共同协作、透明化地完成整个软件的生命周期(需求、设计、编码、构建、部署、运营),而非相互隔离,又或者是借助于多个软件才能完成工作。
225
star
46

mole

Mole - based-git cloud note | 墨乐 - GitHub上的云笔记
JavaScript
222
star
47

techlead

Tech Lead Toolbox
TypeScript
197
star
48

make

📖📖📖📖📖 写给软件工程师看的硬件编程指南
HTML
193
star
49

fde

前端体系规划指南。Architecture of Frontend Development Efficiency
192
star
50

vmap

location:china, GitHub most popular Chinese user in Map
JavaScript
185
star
51

md

A Markdown Editor for Wechat Media Platform
JavaScript
183
star
52

aofe.images

《前端架构:从入门到微前端》原图,image for Architecture of Frontend
161
star
53

smart-home

Phodal's Smart Home Setup Guide:HomeBridge + Home Assistant + Amazon Echo
C++
152
star
54

2md

A Converter for Copy/Paste content to Markdown
JavaScript
151
star
55

trusted

10 factor to build trusted system - 构建可信系统的 10 元素
138
star
56

diaonan

MQTT协议,CoAP协议,WebSocket,物联网协议测试平台
CSS
137
star
57

frontend

《大前端:前端的扩张》
HTML
137
star
58

mifa

Mifa Design
CSS
134
star
59

wecode

A Serverless Gist Application in WeChat. 微信群里的代码协作小程序
JavaScript
125
star
60

lettuce

Mobile Framework for Romantic. 简约的移动开发框架
JavaScript
124
star
61

iot-coap

IoT Learning with CoAP Protocol
JavaScript
121
star
62

awesome-iot-projects

Awesome IoT Projects. A collaborative list of great resources about IoT Demos
112
star
63

setup.guide

前端程序员的 macOS 搭建指南
111
star
64

echoesworks

Next-Generation Tech Blog/Presentation/Slider Framework
JavaScript
109
star
65

water

Water 是开源的下一代软件架构模式,专为云研发/云开发时代设计的软件架构。由实时开发环境 + 云编译、云转译、编程语言数据库等核心要素构建的新一代软件架构模式。
98
star
66

brand

Design for Fun
Python
97
star
67

winv

A mini compatible MINA for web
CSS
91
star
68

growth-in-30-minutes

A Introduction for Growth Paper in Minutes - 真实世界的全栈工程师的十八项必备技能
91
star
69

moqi.mobi

开源移动CMS框架——墨颀移动CMS
JavaScript
86
star
70

javascript-refactor

前端工程师技能训练之重构
JavaScript
82
star
71

ascode.ink

Everything as code architecture design patten and rules。本系列文章是根据《云研发:研发即代码》一文编写的具体实现,将文档、需求、设计、代码、构建、部署、运营变成代码化。
82
star
72

phodaldev

person website
JavaScript
75
star
73

valentine

程序员情人节礼物示例, Valentine's Day Example
JavaScript
75
star
74

layer-architecture

DDD & Clean Architecture in Java, JavaScript, TypeScript, Python, Golang, Cpp
Java
70
star
75

congee

A Web Editor design for Baimizhou
JavaScript
68
star
76

stepping

Stepping - a tools for code design, event storming, domain model generate.
TypeScript
66
star
77

fed

Ebook of Frontend.《我的职业是前端工程师》姐妹篇《前端进阶指南》
HTML
61
star
78

daily

日常练习
CSS
61
star
79

moform

A Serverlesss form builder
JavaScript
58
star
80

dore

React Native-base Hybrid Framework, for migrating Cordova and WebView application to React Native.
JavaScript
55
star
81

growth-code

The Source Code of Growth Paper - 《全栈应用开发:精益实践》源码
Python
55
star
82

summary

Awesome articles, tools, OS project, design of Phodal - collections in path of Phodal's way for new geek & nerd to quick growth
51
star
83

skillwheel

A Skill List for Web Developer
CSS
51
star
84

dou2

一份面向残疾地区的,简单的无障碍上网指南
50
star
85

ionic-elasticsearch

Django ElasticSearch Ionic 打造 GIS 移动应用
JavaScript
49
star
86

awesome-practise-project

Awesome Practise Project
JavaScript
47
star
87

backbone-react

Backbone React in Practice
JavaScript
47
star
88

oan

Another Web Components Framework . A Spike of Web Components Design
TypeScript
45
star
89

mopass

A OpenSource Clientless & Serverless Password Manager
JavaScript
42
star
90

designiot-app

Internet of Things APP
JavaScript
42
star
91

django-elasticsearch

Django ElasticSearch Ionic 打造 GIS 移动应用
JavaScript
41
star
92

awesome-smart-speaker

A Awesome List for Smart Speaker(智能音箱)
41
star
93

growth-in-action-code

Growth In Action Django Code
Python
40
star
94

componentless

Componentless is a architecture pattern which is means component as a services. 无组件(Componentless)架构是一种架构模式,它是指大量依赖于三方组件(运行时依赖的组件而非编译时依赖的组件,即编译即服务)或暂存容器中运行的自定义代码的前端应用。
39
star
95

romantic

待我代码编成,娶你为妻可好
JavaScript
38
star
96

thesis

TeX
36
star
97

design

Design as Code, a DSL for UX & backend modeling. DSL to Sketch file, Sketch to DSL, DSL to code.
Go
36
star
98

designiot-code

Source Code of Design IoT
JavaScript
31
star
99

mooa-boilerplate

microfrontends framewrok mooa's boilerplate.前端微服务化框架 Mooa 脚手架示例
TypeScript
30
star
100

mest

契约测试框架。A TypeScript Contract Test for Interface base project.
TypeScript
29
star