svn目录使用规范.doc

介绍SVN各个目录使用规范 Svn目录使用规范 TortoiseSVN客户端工具 选择创建SVN目录结构的选项（生成trunk、branches、tags目录）,如下图： 1、 trunk是主分支，是日常开发进行的地方。 2、branches是分支。一些阶段性的release版本，这些版本是可以继续进行开发和维护的，则放在branches目录中。 3、tags目录一般是只读的，这里存储阶段性的发布版本，只是作为一个里程碑的版本进行存档。 注：在这需要说明下分三个目录的原因，如果项目分为一期、二期、三期等，那么一期上线时的稳定版本就应该在一期完成时将代码copy到branches上，这样二期开发的代码就对一期的代码没有影响，如新增的模块就不会部署到生产环境上。而branches上的稳定的版本就是发布到生产环境上的代码，如果用户使用的过程中发现有bug，则只要在branches上修改该bug，修改完bug后再编译branches上最新的代码发布到生产环境即可。tags的作用是将在branches上修改的bug的代码合并到trunk上时创建个版本标识 Trunk目录：Doc(文档库，放项目相关文档类)、sourcecede（代码库） Doc目录下按项目存放文档，以下以proj1为例做说明 Proj1----项目名 1、Controlled------组织级scm建一个名为controlled的目录，当项目某文档通过评审后，组织级scm从项目目录下找到那文档，复制到controlled目录下。（一般用不到） 2、Develop---开发文档 2.1、Design----设计文档 2.1.1、DbDesign---数据库设计文档 2.1.2、HLD---概要设计 2.1.3、InterfaceDesign---接口设计 2.1.4、ServiceDesign---服务设计 2.2、REQ---需求文档 2.3、SRS---软件需求规格说明 2.4、Test---测试文档 2.4.1、Review---可空 2.4.2、TestCese---测试用例 2.4.3、TestDoc---测试文档 2.4.4、TestEnv---测试环境说明 2.4.5、TestReport---测试报告 3、Document---项目文档 4、Management---管理文档 4.1、Meetings--会议纪要 4.2、PIM--- 4.3、Plan---计划 4.3.1、review 4.3.2、SDP---软件开发策划文档 4.3.3、SPP---软件项目策划文档 4.4、report---报告 4.4.1、Milestonereport---版本报告 4.4.2、ProjectTrackReport---项目跟踪报告 4..4.3、SCM---软件配置管理文档  4.4.4、SQA---软件质量保证计划 4.4.5、项目周报 4.5、Sow---工作说明书 4.6、Summarize---总结 4.7、Template---模板 4.8、Trainning---培训文档 打标签/分支有两种方式： 1、选中项目，就是trunk下的本地项目，右击，选中Branch/Tag，出现如下对话框。 下图中的配置完成了之后，点击OK即可完成“打标签/分支”。 2、直接在SVN上在对应的标签/分支目录下创建对应的版本文件夹，将trunk下稳定版本的代码直接copy到对应的文件目录下即可。 **SVN目录使用规范** **一、SVN目录结构** 在使用SVN（Subversion）进行版本控制时，遵循一种标准的目录结构有助于保持代码库的整洁和有序。这种结构通常包括三个主要部分：`trunk`、`branches`和`tags`。 1. **trunk**：这是主分支，代表项目的主线开发。日常的开发工作都在这个目录下进行，每次提交的代码都是项目当前的最新状态。trunk中的改动会直接影响到后续的构建和部署。 2. **branches**：分支目录用于存放阶段性的release版本或开发新功能。例如，当需要为项目的一期、二期、三期等不同阶段创建独立的开发线时，可以在这里创建分支。在branches上进行的修改和维护不会影响到trunk，确保了不同开发阶段之间的隔离。 3. **tags**：此目录保存的是项目在特定时间点的稳定版本，通常为只读，用于标记重要的里程碑。例如，当一期项目上线时，将trunk中的稳定代码复制到tags，作为已发布的版本存档。这样，如果需要回溯到某个已知良好状态，可以从tags中获取。 **二、Doc目录结构** 在trunk目录下，有一个`Doc`子目录，专门用于存放项目相关的各种文档。具体如下： 1. **Controlled**：存放经过评审的文档，通常是组织级别的文档管理。 2. **Develop**：开发文档，包括设计文档、需求文档、测试文档等。 - **Design**： - **DbDesign**：数据库设计文档 - **HLD**：概要设计文档 - **InterfaceDesign**：接口设计文档 - **ServiceDesign**：服务设计文档 - **REQ**：需求文档 - **SRS**：软件需求规格说明 - **Test**：测试文档，包含测试用例、测试文档、测试环境说明、测试报告等。 3. **Document**：项目整体文档 4. **Management**：项目管理文档，包括会议纪要、计划、报告等。 - **Meetings**：会议纪要 - **PIM**：项目信息管理 - **Plan**：软件开发策划和项目策划文档 - **report**：各种报告，如版本报告、项目跟踪报告、软件配置管理文档、软件质量保证计划、项目周报等 - **Sow**：工作说明书 - **Summarize**：总结 - **Template**：模板 - **Trainning**：培训文档 **三、创建和管理分支与标签** 创建分支或标签主要有两种方法： 1. 使用TortoiseSVN客户端工具的`Branch/Tag`功能，选择本地trunk项目，然后指定新的分支或标签路径，点击OK完成操作。 2. 在SVN服务器的对应分支或标签目录下直接创建新文件夹，然后将trunk中的稳定版本代码复制过去。 分支和标签的管理对于团队协作至关重要。当在branches上修复了bug，需将这些更改合并回trunk，确保主线始终保持最新且稳定。同时，使用tags来记录每个发布版本的状态，便于日后追溯和维护。 遵循SVN目录使用规范能够提升项目管理效率，确保代码和文档的有序性，便于团队成员协作和项目的长期发展。正确使用trunk、branches和tags，以及维护好文档库，能有效支持软件开发过程中的版本控制和知识管理。