命令行创建项目文档目录结构

命令行创建项目文档目录结构

wishmo@tom.com 2016年1月21日11:10:59

文档化有助于减轻记忆压力，有利于在互联网时代顺畅分享
建议用Cmd MarkDown打开，DOS脚本有语法高亮。

缘起

之前整理所有项目文档的时候，发现项目结构与内容不协调：

1. 纯文档项目，采用的商业项目管理目录，很多目录都是空的；
2. 纯代码项目，采用商业项目管理目录，文档多是空的；
3. 繁复的项目目录，会令人望而生畏，不利于文档化；
4. 冗余的目录，很难快速找到所需文档资料
5. 更好的方式，是用数据库管理文档并建立全文索引。这样保证最新的文档有且只有一份，且各条文档逻辑线完整。如合同-启动-计划-实施-控制-收尾过程组文档、需求-概要设计-详细设计-编码-测试-部署-试运行-用户手册-验收-维护2条线的文档都是完整的。

做法

采用MSDOS命令行，MSDOS编辑扩充简单，与Windows系统结合较好；

源码

源码存放于F:\mytool\prjMD.bat中

@echo off
echo                            创建项目文档结构
echo                   by wishmo@tom.com 2016年1月21日
echo 用法: prjmd 项目根目录 文件夹结构模式
echo.
echo 模式1：资料、方案、结果、说明，适用于纯实验性质的项目
echo.
echo 模式2：资料、方案、源码、部署、用户手册、结果（截图）、说明，
echo        用于需要简单编程的实验项目
echo.
echo 模式3：资料、文档、方案、环境搭建、源码（测试）、部署、用户手册、结果（截图）、说明，
echo        用于需要框架编程的实验项目
echo.
echo.
echo 模式4：资料、合同、启动、计划、实施、控制、收尾、说明
echo        用于正式的计算机商业项目。需求、设计、编码、测试、部署、用户手册、运维、
echo        沟通（会议纪要、汇报、通知、周报日报），如何嵌入
echo.
echo.
rem 新建项目工程目录
if /i not ""%1""=="""" (md ""%1""
set oldcd=%cd%
cd /d ""%1""
)
if /i "%2"=="-1" (    goto simplemode
) else if /i "%2"=="-2" ( goto simplecodemode
) else if /i "%2"=="-3" ( goto frameworkmode
) else if /i "%2"=="-4" ( goto businessmode
) else if /i "%2"=="-5" ( goto end
) else goto end
:simplemode
md "01 资料" "02 方案" "03 结果"  
goto tree
:simplecodemode
md "01 资料" "02 方案" "03 源码" "04 部署" "05 用户手册" "06 结果"\"01 截图" "07 说明"  
goto tree
:frameworkmode
md "01 资料"
md "02 文档"
md "03 方案"
md "04 环境搭建"
md "05 源码"\"01 用例图"
md "05 源码"\"02 结构图"
md "05 源码"\"03 流程图"
md "05 源码"\"04 依赖库和环境"
md "05 源码"\"05 源码"
md "05 源码"\"06 测试"
md "06 部署"
md "07 用户手册"
md "08 结果"\"01 截图"
md "09 说明"
goto tree
:businessmode
md "00 资料"
md "01 合同"
md "02 启动"
md "03 计划"
md "04 实施"
md "05 控制"
md "06 收尾"
md "07 说明"
md "A0 需求"
md "A1 设计"
md "A2 编码"
md "A3 测试"
md "A4 部署"
md "A5 用户手册"
md "A6 运维"
md "+00 验收文档"
md "+01 沟通"\"01 会议纪要"
md "+01 沟通"\"02 汇报"
md "+01 沟通"\"03 周报"
md "+01 沟通"\"04 通知"
goto tree
:tree
tree .
echo. > ReadMe.md
:end 
cd /d %oldcd%

说明

后续可以根据实际需要进行扩充。

来自为知笔记(Wiz)