<h1 id="readme驱动开发rdd实践笔记">Readme驱动开发（RDD）实践笔记<a aria-hidden="true" class="anchor-heading icon-link" href="#readme驱动开发rdd实践笔记"></a></h1>
<h1 id="readme驱动开发rdd提升软件开发效率与质量的新方法">Readme驱动开发（RDD）：提升软件开发效率与质量的新方法<a aria-hidden="true" class="anchor-heading icon-link" href="#readme驱动开发rdd提升软件开发效率与质量的新方法"></a></h1>
<p>在软件开发领域，我们经常探讨如何提高开发效率和软件质量。近年来，一种名为Readme驱动开发（RDD）的方法引起了广泛关注。这种方法由GitHub的联合创始人Tom Preston-Werner提出，它强调在编写代码之前，首先创建一个清晰的Readme文档。</p>
<h2 id="rdd的核心概念">RDD的核心概念<a aria-hidden="true" class="anchor-heading icon-link" href="#rdd的核心概念"></a></h2>
<p>RDD是一种软件开发方法，它要求开发者在编写任何代码之前，先编写一个Readme文档。这个文档应该清晰地描述软件的用途、功能、API接口和使用方式。通过这种方式，RDD确保软件开发的方向和内容与用户需求相匹配，从而提高开发效率和软件质量。</p>
<h2 id="rdd的优势">RDD的优势<a aria-hidden="true" class="anchor-heading icon-link" href="#rdd的优势"></a></h2>
<ol>
<li><strong>明确方向</strong>：通过前期的文档编写，确保项目目标和需求清晰，避免在错误方向上浪费时间。</li>
<li><strong>易于沟通</strong>：Readme文档作为项目的第一份文档，有助于团队成员和其他利益相关者理解项目的目的和功能。</li>
<li><strong>减少返工</strong>：清晰的文档可以在早期发现问题，减少开发过程中的代码修改。</li>
<li><strong>提高可维护性</strong>：良好的文档有助于新成员快速了解项目，提高代码的可维护性。</li>
</ol>
<h2 id="实施rdd的步骤">实施RDD的步骤<a aria-hidden="true" class="anchor-heading icon-link" href="#实施rdd的步骤"></a></h2>
<ol>
<li><strong>确定目标</strong>：在编码前，明确软件需要解决的问题和目标用户群体。</li>
<li><strong>编写Readme</strong>：创建一个简洁明了的Readme文档，描述软件的用途、功能、API接口和使用方式。</li>
<li><strong>团队讨论</strong>：与团队成员一起审阅Readme文档，确保共同理解。</li>
<li><strong>编码实现</strong>：在Readme文档的指导下开始编码，确保每一步都符合文档描述。</li>
<li><strong>持续更新</strong>：随着项目进展，不断更新Readme文档，保持文档与代码的一致性。</li>
</ol>
<h2 id="实践中的建议">实践中的建议<a aria-hidden="true" class="anchor-heading icon-link" href="#实践中的建议"></a></h2>
<ol>
<li><strong>简洁明了</strong>：确保文档简洁，避免冗长和复杂术语。</li>
<li><strong>使用示例</strong>：提供清晰的使用示例，帮助用户快速理解如何使用项目。</li>
<li><strong>项目结构</strong>：组织清晰的项目文件和目录结构，便于其他开发者理解和参与。</li>
<li><strong>贡献指南</strong>：制定明确的贡献指南，鼓励社区成员参与项目。</li>
</ol>
<h2 id="资讯来源">资讯来源<a aria-hidden="true" class="anchor-heading icon-link" href="#资讯来源"></a></h2>
<p>Tom Preston-Werner是RDD概念的提出者，他在自己的博客文章中有详细描述RDD的理念和实践方法。通过实践RDD，开发者可以更系统地规划和管理项目，提升开发效率和代码质量。这种方法适用于个人和团队项目，值得每位开发者尝试和实践。</p>
<hr>
<h2 id="tags">Tags<a aria-hidden="true" class="anchor-heading icon-link" href="#tags"></a></h2>
<ol>
<li><a class="color-tag" style="--tag-color: #fdc1c5;" href="/notes/x6h3yqz3zv0nmgq9dw0olq1">开发</a></li>
<li><a class="color-tag" style="--tag-color: #645403;" href="/notes/v1zm9rr62uhe3qr6ksko45c">设计</a></li>
</ol>
<hr>
<strong>Backlinks</strong>
<ul>
<li><a href="/">伟's 博客首页</a></li>
</ul>

Readme驱动开发（RDD）：提升软件开发效率与质量的新方法

Readme驱动开发（RDD）实践笔记

CLI Param Concat 命令参数拼接管理工具

**找工作 ing**

## 技能介绍

### 开发技能
- **基本技术**: html css javascript typescript
- **前端框架**：精通 Vue.js（包括 Vue2 和 Vue3）、微信原生小程序、uniapp 以及鸿蒙 HarmonyOS next 开发
- **后端和运维**：熟练使用 Node.js、空间托管年代配置过 apache, 后来在公司技术总监不在的时候也负责处理 nginx 部署
- **预处理器**：熟练使用 Sass 和 Less
- **工具与构建**：熟练使用 WebSocket、Webpack、Vite、鸿蒙 ArkTS 和 ArkUI
- **数据库与后端语言**：在查找文档帮助下可以使用 MySQL 和 PHP（多年前熟练，现在放下了）
- **脚本语言**：了解并试用过 Python，能够在 AI 帮助下编写脚本

### 电脑美工

- **图像处理**：熟练使用 Photoshop
- **图形设计**：了解并能配合设计师处理 Illustrator

### 编程框架

- **前端框架**：十分熟练 Vue.js 和 jQuery
- **CMS 和电子商务**：多年前用过 Magento、Opencart、Wordpress，学生时代用过 Joomla 和 Three.js、Zepto

### 管理和规范化工具

- **版本控制**：工作中使用 Git 和 GitHub Actions
- **进程管理**：使用 pm2
- **容器化**：使用 Docker

### 运维

- **Linux 环境**：基本 Linux 环境管理运维
- **Web 服务器**：除了 Node.js 以外，可以查文档使用 Apache 和 Nginx

### AI 人工智能

- **AI 框架**：有基本搭建部署使用经验，包括 RAG、本地 Ollama
- **图像生成**：有使用经验，包括 Stable Diffusion

## 教育背景
- **2010-2011**：巴黎第十三大学，网络多媒体策划与实践方向 CIWM
  - 专注于网络多媒体内容的策划、设计和实践，包括但不限于网站设计、互动媒体和数字内容管理。
- **2008-2010**：巴黎第十三大学，网络传媒专业 SRC
  - 学习了网络传媒的基础知识，包括网络传播理论、数字媒体技术和传媒法规等。

## 工作经历
**法国部分**
### 2012-2013
- **公司**: sushikyo94.fr, Vadinoe.com
- **职位**: 独立开发者
- **项目**: 独立完成两个网店开发
  - 使用 Opencart 完成一个网店开发
  - 使用 Wordpress 完成另一个网店开发

### 2013-2014
- **公司**: Flashboutique
- **职位**: 网店开发者
- **项目**: Opencart 网店二次开发
  - 包括轮盘游戏开发，基于开源代码

### 2015-2017
- **职位**: 全栈开发者
- **项目**: 多个项目，包括工作和外包
  - **Tokyo95.fr**
    - 寿司店外卖 Magento 系统
  - **Immo75.paris**
    - 房地产租售信息平台网站 Wordpress 系统
  - **Faguoyaodian.com**
    - 法国药妆代售系统，Magento 系统
  - **Aimu.fr**
    - 中国寝具工厂法语网站，巴黎展会使用
    - 备注：网站应该已经改版
  - **Luxaword.com**
    - 巴黎免税店在线商店
    - 负责前端修改, SEO 优化和 Google 广告分析和优化

**中国部分**
### 2017-2019
- **公司**: 微来（中国）有限公司
- **职位**: 前端组长
- **职责**:
  - 负责技术选型
  - 架构优化和框架维护
  - 安排开发任务
  - 实际参与项目最终实现
- **项目**
  - **澳蚁** app
    - **项目描述**: 一款跨境电商保健品分销前后台
    - **技术栈**: Vue + Node.js + Java
    - **我的职责**:
      - 负责 Vue 和 Node.js 开发
      - 后用 UniApp 实现小程序、WebApp 和 iOS、Android App

  - **砍砍猫**
    - **项目描述**: 一款专注于砍价商品发布的小程序平台
    - **技术栈**: UniApp
    - **我的职责**:
      - 使用 UniApp 实现小程序, nodejs 实现 websocket 和反向代理

  - **小名片**
    - **项目描述**: 一款无代码名片编辑生成小程序
    - **技术栈**: UniApp
    - **我的职责**:
      - 使用 UniApp 实现小程序, nodejs 实现 websocket 和反向代理

  - **winnet 微来中国官网**
    - **项目描述**: 中法双语公司介绍
    - **技术栈**: wordpress php

## 个人项目

### SQLite数据库备份工具
[Gitee链接](https://gitee.com/imyyliang/sqlite-database-backup-tool)  
一个自动备份SQLite数据库文件的解决方案，它提供了一个简单的Web界面，方便用户查看备份记录和管理数据库备份状态。该项目通过定时扫描和备份.db文件，确保数据的安全性和完整性。

### Chrome 标签页AI分类插件
[Gitee链接](https://gitee.com/imyyliang/tab-auto-group)  
一款浏览器扩展程序，它通过采用本地AI大模型技术，如Ollama，自动为您的浏览器标签页进行智能分组，极大地提升了用户的浏览效率和体验。本插件不仅能够根据网页内容自动推荐合理的分组，还支持用户手动调整和管理标签，确保了灵活性和个性化。同时保护用户隐私，避免了将数据发送到外部服务器，从而无需依赖外部API密钥。

### CLI Param Concat 命令参数拼接管理工具
[GitHub链接](https://github.com/LiangWei88/cli-param-concat#readme)  
CLI Param Concat 是一个基于 Node.js 开发的命令行参数管理工具，它通过读取文件中的参数并将其自动拼接到用户定义的命令中，简化了命令行参数的手动输入和管理。  
该工具通过减少重复性任务和提高命令行操作的效率，帮助开发者更高效地执行复杂的命令行任务，同时避免了手动输入参数时可能出现的错误。

### 码云贡献爬取工具
**第二版:** [Gitee链接](https://gitee.com/imyyliang/gitee-contribute-scraper)  
一个代码作业监控工具，它具有一个简洁的Web界面，允许教师输入学生的Gitee用户名。系统会自动收集每个学生的最近代码提交，并在网页上展示。此外，它还具备一个筛选功能，可以高亮显示那些在最近几天内没有提交代码的学生，使得教师能够迅速识别出哪些学生可能需要额外的关注或辅导。  
**第一版:** [Gitee链接](https://gitee.com/imyyliang/code-checking)  
一个自动化作业检查工具，它通过收集学生的Git仓库地址，自动爬取代码提交数据，并生成Markdown格式的报告，以便于教师快速查看和评估学生的代码提交情况。代码中包含了对GitHub和Gitee仓库的访问，以及对数据的格式化处理。

### 作业提交系统
[Gitee链接](https://gitee.com/imyyliang/homework-submission-system)  
这是一个专为学生简历和自我介绍逐字稿设计的在线作业提交和批改平台。它允许教师通过简单的数据导入来管理学生作业，提供便捷的批改和反馈机制，帮助学生在求职前优化他们的简历和自我介绍。虽然最初计划包含更全面的班级和学生管理功能，但项目最终聚焦于核心的批改功能，以满足基本的教学需求。  

### 井字棋
[Gitee链接](https://gitee.com/imyyliang/tic-tac-toe)  
为学生讲解JavaScript时编写的教学示例。它利用Vue框架快速搭建，旨在通过一个互动性强的游戏实例，帮助学生理解JavaScript在实际应用中的运用，同时加深他们对前端开发的理解。

### 局域网评分投票工具
[Gitee链接](https://gitee.com/imyyliang/lan-score)  
修改自一个同事的代码, 一个基于Node.js的局域网评分投票工具，它允许学生在展示项目后，通过访问老师机器的IP地址来进行评分。这个工具不仅记录了每个参与者的评分，还计算并展示了去除最高分和最低分后的平均分，以及详细的评分记录。

### Opencart 欧洲发票号修改插件
[官网链接](https://www.opencart.com/index.php?route=marketplace/extension/info&member_token=9f4d2aa7c5ee7a444c7fc54d1b034053&extension_id=24685)  
Change Invoice Number 是一个 OpenCart 扩展工具，它允许管理员在订单详情标签页手动输入和覆盖发票号码，增强了财务文件的定制和控制能力。这个插件是基于现有工具修改并修复了bug，经过OC 1.5.3.1和OC 1.5.6.1版本测试，它允许在发票生成后动态更改发票前缀和号码，并且修复了一个关键问题，确保发票前缀保留，以避免重新生成发票时出现编号冲突。

### webpack-px2rem-loader
[Github链接](https://github.com/LiangWei88/webpack-px2rem-loader)  
一个实用的 webpack loader 优化版，它能够自动将 CSS 和 JS 中的像素值转换为 rem 单位，极大地简化了响应式设计的流程。它还修复了原插件中处理 media query 的 bug，确保了在不同屏幕尺寸下的兼容性。通过简单的配置，开发者可以轻松地在项目中实现像素到 rem 的转换，提高开发效率。

### css 长度单位转换器
[GitHub链接](https://github.com/LiangWei88/Design-size-convertor)  
提供一个网页界面提交css文件, 能够智能地识别和转换CSS代码中的 px rem 等单位，支持等比转换和按比例转换，确保设计的一致性和准确性。这个工具不仅提高了前端开发的效率，还保证了在不同设计稿尺寸下的兼容性。

### "键盘侠"
[Gitee链接](https://gitee.com/imyyliang/jianpanxia)  
一个键盘增强工具，它通过AutoHotKey脚本将Capslock键转变为Esc键，并赋予其vim风格的快捷键功能，极大提升了键盘的效率和灵活性。同时，它还扩展了数字键的快捷操作，通过Shift+Alt组合键快速输入数字，为无小键盘电脑日常编程和文本编辑带来便利。

### AutoSiteScreenShot
[Github链接](https://github.com/LiangWei88/AutoSiteScreenShot)  
一个自动化网页截图工具，它能够针对单一网页在多种不同分辨率下生成截图，非常适合用于测试和验证网页在不同屏幕尺寸下的显示效果。这个工具简单易用，只需配置网址和分辨率，即可一键获取所需截图，极大地方便了网页设计的兼容性测试。

### 简单 leetcode 题解
[Github链接](https://github.com/LiangWei88/leetcode)  
几年前摸鱼时候写的一些题目


### Basscss 原子css
[Gitee链接](https://gitee.com/imyyliang/basscss)  
Basscss，一个轻量级的CSS工具库，提供无副作用的模块化样式，旨在提高开发速度和代码可读性。它以简洁和易用性为核心，是小型项目和个人开发者的理想选择，同时与Tailwind CSS和UnoCSS等流行库相比，提供了一个更为精简的原子类库解决方案。

### 前端输入法词库
[GitHub链接](https://github.com/LiangWei88/WebDevDictCN)  
WebDevDictCN 是一个专为前端工程师和程序员设计的搜狗输入法词库，整合了1000+个与前端开发、编程和计算机相关的专业术语，旨在提高输入效率和准确性。它支持直接导入搜狗输入法，也兼容其他输入法，如讯飞，通过简单的编辑和导入操作即可使用。

## 获得荣誉

- **2018年** - 法律黑客松广州赛区亚军
- **2019年** - 传智播客广州校区最佳新人
- **2022年** - 传智播客广州校区优秀员工

## 证书

- 2008 年法语 B2
- 软考中级软件设计师

## 沟通语言

- **法语**：熟练
- **英语**：阅读熟练，口语一般
- **普通话和粤语**：母语

## 文章列表

### [[2016]]
- [[2016.如何在功能性和灵活性之间找到平衡？——以老版Wiz为知笔记为例]]
- [[2016.谁动了我的硬盘？电脑数据容量单位科普入门浅析]]

### [[2017]]
- [[2017.WordPress 迁移后遇到的问题及解决方案]]
- [[2017.如何合理定价建站服务？]]
- [[2017.网站价值几何？]]
- [[2017.网页设计定价：揭秘背后的故事]]

### [[2023]]
- [[2023.Vue-Admin-Work 运行时 Codemirror 错误解决方案]]
- [[2023.前端 vue 基本功自测]]

### [[2024]]
- [[2024.ai读博客 Effective Prompt 编写高质量Prompt的14个有效方法]]
- [[2024.Readme驱动开发（RDD）实践笔记]]
- [[2024.个人笔记软件思考 - Obsidian vs logseq 和其他]]
- [[2024.鸿蒙HarmonyOS开发高级认证知识点总结]]
- [[2024.Docker镜像拉取困难？看这里！阿里云部署Dashy的成功案例]]
- [[2024.打造高效的个人知识管理系统：我的思考与实践]]
- [[2024.SQLite 数据库备份工具 README]]
- [[2024.使用 AI 辅助开发阿里云 OSS 自动备份工具及监控功能]]
[[2024.React 源码分析 - 第一部分架构说明]]

# TODO 待编写介绍
- 2018 法律黑客松广州赛区亚军
- 断食记录小程序
- github 状态
- gitee 标签
- npm 标签
- 自己写的脚本油猴
- youtube 总结工具本地大模型版本
- [题库管理工具](https://gitee.com/imyyliang/question-bank-management)