首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
您找到你想要的搜索结果了吗?
是的
没有找到

5步搭建一个测试文档管理网站

安装Sphinx Sphinx是一个基于Python的文档生成项目,最早只是用来生成 Python 官方文档,随着工具的完善,越来越多的知名的项目也用他来生成文档。...Sphinx的原理很简答,就是把特定格式书写的文档,通过约定的转换方式,生成对应的HTML文档。这里书写的文档可以支持多种格式,生成的HTML也可以支持多种模板。...创建一个文档项目 安装好Sphinx之后,我们就可以通过它来创建实际的文档项目,主要命令如下: mkdir -p /data/testdocs cd /data/testdocs sphinx-quickstart...# 进入文档创建选项过程 进入文档创建选项过程之后,按照自己的需求来选择具体选项。...编写第一个文档 现在开始就可以创建真正的文档了,具体需要3步: 1.在source目录下创建一个.rst的文件,如:hello.rst2.文件内容为rst格式文本3.修改source/index.rst

72620

实战 | docsify+云开发,高效创造你的文档网站

想要将docsify生成的文档网站发布出去,以前我们会选择GitHub Pages来进行网站托管。但由于GitHub是国外网站,会导致你的文档网站访问速度较慢。...云开发静态网站托管支持通过云开发SDK调用服务端资源如:云函数、云存储、云数据库等,从而将静态网站扩展为全栈网站。...下面,只需5分钟,利用docsify+云开发高效创造和部署你的个人文档网站吧! 系统依赖 在进行后续的内容前,请先确保你的电脑中安装了 Node.js 运行环境。...文档网站已经生成,但此时仅自己本地可见。如何让其他人看到自己的网站呢? 我们可以利用云开发的静态托管部署功能,只需几步,轻松发布自己的网站。...用静态托管部署你的文档网站 首先进入腾讯云的云开发(cloudbase)控制台: ? 点击立即创建,开通一个云环境: ?

1.2K40

软件测试中的测试文档

什么是测试文档测试文档是在软件测试之前或期间创建的工件的文档。它可以帮助测试团队估计所需的测试工作,测试覆盖范围,资源跟踪,执行进度等。...测试文档使测试的计划,审查和执行变得容易且可验证。 测试形式的程度取决于 测试中的应用程序类型 您的组织遵循的标准 开发过程的成熟度。 测试活动通常消耗软件开发项目工作的30%到50%。...文档有助于确定可应用于将来项目的测试过程改进。 测试文档示例 这里是重要的测试文档类型: 测试类型 说明 测试政策 这是一个高级文档,描述了组织的原理,方法和所有重要的测试目标。...测试用例 它是一组输入值,执行先决条件,预期的执行后置条件和结果。它是针对测试场景而开发的。 测试数据 测试数据是在执行测试之前存在的数据。它用来执行测试用例。...测试形式的程度取决于1)被测应用程序的类型2)组织遵循的标准3)开发过程的成熟度。 测试文件的重要类型是测试策略,测试策略,测试计划,测试用例等。

2.8K00

软件测试中的测试文档

什么是测试文档测试文档是在软件测试之前或期间创建的工件的文档。它可以帮助测试团队估计所需的测试工作,测试覆盖范围,资源跟踪,执行进度等。...但是在现实世界中,测试是一项非常正式的活动,并有详细记录。测试文档使测试的计划,审查和执行变得容易且可验证。 测试形式的程度取决于 测试中的应用程序类型 您的组织遵循的标准 开发过程的成熟度。...测试活动通常消耗软件开发项目工作的30%到50%。文档有助于确定可应用于将来项目的测试过程改进。...测试场景 测试场景是软件系统的一项或一项,可以通过一个或多个测试案例进行验证。 测试用例 它是一组输入值,执行先决条件,预期的执行后置条件和结果。它是针对测试场景而开发的。...测试形式的程度取决于1)被测应用程序的类型2)组织遵循的标准3)开发过程的成熟度。 测试文件的重要类型是测试策略,测试策略,测试计划,测试用例等。

1.7K20

Python 6.3 文档测试

文档测试 如果你经常阅读Python的官方文档,可以看到很多文档都有示例代码。比如re模块就带了很多示例代码: >>>import re >>>m = re.search('(?...<=abc)def','abcdef') >>>m.group(0) 'def' 这些文档和其他说明可以写在注释中,然后,由一些工具来自动生成文档。...并且,Python内置的‘文档测试(doctest)’模块会直接提取注释中的代码并执行测试。 doctest严格按照Python交互式命令行的输入和输出判断测试结果是否正确。...只有测试异常的时候,可以用...一大段烦人的输出。...所以,不必担心doctest会在非测试环境下被运行。 小结: doctest非常有用,不但可以用来测试,还可以直接作为示例代码。通过某些文档生成工具,就可以自动把包含doctest的注释提取出来。

43630

测试思想-系统测试  用户文档测试(摘录)

文档类型 用户手册 安装和设置指导 联机帮助 指南、向导 样例、示例和模板 授权/注册登记表 最终用户许可协议 测试要点 读者群:文档面向的读者定位要明确。...正确性:测试中需检查所有信息是否真实正确,不出现错别字,查找由于过期产品说明书和销售人员夸大事实而导致的错误。...完整性:对照软件界面检查是否有重要的分支没有描述到,甚至是否有整个大模块没有描述到,主要是测试文档内容的全面性。 一致性:检查文档描述与实际结果的一致性。...按照文档描述的操作执行后,检查软件返回的实际结果是否与文档描述的相同。检查所有图表与界面截图是否与发行版本 相同。检查样例与示例,像用户一样载入和使用样例。...需要注意的是文档要有助于用户排除错误。不但描述正确操作,也要描述错误处理办法。文档对于用户看到的错误信息应当有更详细的文档解释。 无二义性:不要出现有二义性的说法。

58710

SpringBoot整合Docsify生成网站文档

关于Docsify 官网地址:https://docsify.js.org/ 在Docsify官网对Docsify是这样的描述的, docsify 是一个动态生成文档网站的工具。...),个人觉得没有必要去搭建一个项目去做这件事,就好像我写了一个 接口,我更加希望在该项目中直接写好文档,然后可以直接看。...编写templates目录下的doc.html,这里和文档介绍相似 <!...于是 每天学Java的网站也就出来了,网站将小程序的题库数据抽离出来,在加上新的模块:功能集锦,用 于将自己工作中使用的技术进行一次整理封装和优化。...到这里就完成SpringBoot结合Docsify生成文档,笔者觉得在一些小项目中,这样可以非常快速的 生成网站文档,不用另外新建项目。

1.6K40

漫谈测试成长之探索——测试文档

随着敏捷开发模式的流行,版本交付周期缩短,测试工期压缩,一线测试工程师不仅工作节奏加快,而且工作量也在加大。但是,我们的成长速度似乎越来越慢。这是为什么呢?...文档内容如图2-1所示,此测试文档包含以下六类信息:需求分析、需求开发方案设计、需求开发、需求测试、需求发布和其他需求信息。本文将此测试文档定义为探索型测试文档。...探索型测试文档不再只是关注系统测试节点的相关文档,而是以整个需求开发生命周期的视角来收集所有有利于测试保障工作和测试能力提升的文档。...需求开发方案设计中,除了关注《接口设计文档》,我们还可以更深入了解《数据库设计文档》,这样能帮助测试工程师更深入学习到系统的数据流。...需求开发阶段,似乎和我们测试工程师没什么关系,但是实际上我们可以关注项目代码仓库地址,开发的每一次代码提交都会记录在仓库中。

22920

Linux在线搭建自己的文档网站

1. teedoc 简介 一款用 Python 写的文档网站生成工具,支持从 Markdown 或者 jupyter notebook 转换成 HTML,支持多文档,多语言,支持自定义页面等功能 效果和文档...: github.com/teedoc/teedoc.github.io 将 Markdown 或者 Jupyter Notebook 格式的文档转换为 HTML 网页 像其他工具也有read the...docs, docusaurus,docsify,gitbook等等 teedoc使用了 Python 作为开发语言,足够简单易用,要做自定义也很简单, 前端也只用了一个jquery,没有其它复杂的框架...,相信很多开发者都有能力基于这个进行自定义开发,另外也支持插件哦~ 2....特性 使用简单, 跨平台,只依赖 Python3 部署简单, 生成的网站是全静态页面,直接拷贝到服务器或者上传到三方机构即可部署 书写简单,使用 Markdown 语法编写 Jupyter notebook

4.4K50
领券