command line Create project Document directory structure

command line Create project Document directory structure

[Email protected] January 21, 2016 11:10:59

Documentation helps to reduce memory pressure and facilitates seamless sharing in the internet age
It is recommended to open with Cmd markdown, the DOS script has syntax highlighting.

Origin

When all the project documents were collated, it was found that the project structure was not in harmony with the content:

1. Pure document projects, the use of Business Project management directory, many catalogs are empty;
2. Pure code projects, the use of Business Project Management directory, the document is more empty;
3. The complicated project catalogue will be intimidating and not conducive to documentation;
4. Redundant catalogs that make it difficult to find the documentation you need quickly
5. A better way is to use 数据库 management documents and build them 全文索引 . This ensures that the latest document has only one copy, and that the logical lines of each document are complete. Documents such as 合同-启动-计划-实施-控制-收尾过程组 documents, 需求-概要设计-详细设计-编码-测试-部署-试运行-用户手册-验收-维护 2 lines of documentation are complete.

Practice

With the MSDOS command line, the MSDOS editing is simple, and the combination of Windows system is better;

Source

The source is stored in F:\mytool\prjMD.bat

  
 

   
  

  
@echo off
   
  

  
echo 创建项目文档结构
   
  

  
echo by [email protected].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
   
  

  
  )   /span>else    if    / i   "%2"  ==   "2"     (   goto   Simplecodemode   
   
  

  
  )   /span>else    if    / i   "%2"  ==   "3"     (   goto   Frameworkmode   
   
  

  
  )   /span>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%
  
 

Description

The follow-up can be augmented according to actual needs.

From for notes (Wiz)

Command line to create the project document directory structure