docToolchain

docToolchain

将软件架构文档视为代码的开源工具链

docToolchain是一个开源工具链,采用docs-as-code方法处理软件架构文档。它集成arc42模板,将文档管理与代码开发流程相结合,支持版本控制和自动化操作。工具功能包括图表生成和HTML检查,旨在提高技术文档的质量和可维护性。目前已在多家知名企业中应用,并获得活跃社区的支持和贡献。

docToolchain文档生成软件架构开源项目docs-as-codeGithub

:imagesdir: images

== docToolchain

:url-ci-travis: https://app.travis-ci.com/github/docToolchain/docToolchain

image:https://api.travis-ci.com/doctoolchain/doctoolchain.svg?branch=ng[link={url-ci-travis}]

[NOTE]

新冠肺炎疫情正在造成影响。 这段时间里大家时间紧张,一些问题无法及时处理。 因此我(rdmueller)刚刚引入了优先级更高的"赞助"问题。 这个标签应该有助于解释为什么某些问题会优先于其他问题得到处理。 如果你想赞助某个问题,只需使用本页面顶部的赞助链接即可。

[IMPORTANT]

如果你以前使用过docToolchain,请注意主分支正在进行一些更改。

如果你想要一个全新的版本,并且愿意接受配置上的变化,那么这个"ng"分支就是你需要的。

如果你想要你熟悉的版本,那么请下载https://github.com/docToolchain/docToolchain/releases[V1.0.0发布版]

image:https://travis-ci.org/docToolchain/docToolchain.svg?branch=master["构建状态", link="https://travis-ci.org/docToolchain/docToolchain"] image:https://opencollective.com/doctoolchain/backers/badge.svg["Open Collective上的支持者"] image:https://opencollective.com/doctoolchain/sponsors/badge.svg["Open Collective上的赞助商"]

=== 创建精彩文档!

docToolchain 是软件架构http://www.writethedocs.org/guide/docs-as-code/[_文档即代码_]方法的一种实现。 docToolchain的基础是将软件文档与代码同等对待的理念,以及http://arc42.org[_arc42_]软件架构模板。

https://docToolchain.github.io/docToolchain[阅读更多...]

image::https://doctoolchain.github.io/docToolchain/v2.0.x/images/ea/Manual/Overview2.png[]

https://doctoolchain.github.io/docToolchain/v1.3.x/htmlchecks/[HTML完整性检查测试结果]

=== 贡献者

本项目的存在要感谢所有做出贡献的人!

image::https://opencollective.com/doctoolchain/contributors.svg?width=600&button=false[]

另请参阅文档中的https://doctoolchain.github.io/docToolchain/v2.0.x/010_manual/040_contributors.html[贡献者列表]。

每一份贡献都非常宝贵且受到赞赏,无论大小。 即使只是修复一个拼写错误或为项目加星标也有助于推广它。

我决定给予个人和公司支持这个项目的机会。 这是通过https://opencollective.com实现的 - 与https://asciidoctor.org/[Asciidoctor]使用的服务相同。

=== 使用docToolchain的公司

docToolchain仍然是较小的开源项目之一, 但一些公司已经通过docToolchain全面采用文档即代码的方法。 如果你的公司使用docToolchain,欢迎通过拉取请求添加公司标志。 请在PR中声明我们可以在所有项目网站和文档中显示该标志。

[cols="1,2"] |=== a| [link=https://www.tomtom.com] image::TomTomLogo.png[TomTom, width=50%]

a| [link=https://www.dbsystel.de] image::db-logo.svg[DB Systel, width=50%]

a| [link=https://www.codecentric.de] image::cclogo.png[codecentric, width=50%]

a| [link=https://www.innoq.com] image::innoq-logo.svg[INNOQ, width=50%] |===

=== 支持者

感谢所有支持者!

image::https://opencollective.com/doctoolchain/backers.svg?width=890["成为支持者", link="https://opencollective.com/doctoolchain#backers"]

=== 赞助商

通过成为赞助商来支持我们。你的标志将出现在这里并链接到你的网站。

https://opencollective.com/doctoolchain#sponsors[成为赞助商]

image::https://opencollective.com/doctoolchain/sponsor/0/avatar.svg["赞助商", link="https://opencollective.com/doctoolchain/sponsor/0/website"]

=== 本项目的历史

我刚刚发现了一条较早的https://twitter.com/RalfDMueller/status/668540860649349120[推文],它让我想起了这个项目的根源和开端。 一切都始于两个重要部分。 一个名为asciidoc2confluence的脚本和一些从企业架构中导出图表的脚本。

第一个在上面的推文中有链接,第一次提交可以追溯到2015年年中。 从那时起,许多贡献者加入了进来! 感谢你们所有的贡献!

编辑推荐精选

iTerms

iTerms

企业专属的AI法律顾问

iTerms是法大大集团旗下法律子品牌,基于最先进的大语言模型(LLM)、专业的法律知识库和强大的智能体架构,帮助企业扫清合规障碍,筑牢风控防线,成为您企业专属的AI法律顾问。

SimilarWeb流量提升

SimilarWeb流量提升

稳定高效的流量提升解决方案,助力品牌曝光

稳定高效的流量提升解决方案,助力品牌曝光

Sora2视频免费生成

Sora2视频免费生成

最新版Sora2模型免费使用,一键生成无水印视频

最新版Sora2模型免费使用,一键生成无水印视频

Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
商汤小浣熊

商汤小浣熊

最强AI数据分析助手

小浣熊家族Raccoon,您的AI智能助手,致力于通过先进的人工智能技术,为用户提供高效、便捷的智能服务。无论是日常咨询还是专业问题解答,小浣熊都能以快速、准确的响应满足您的需求,让您的生活更加智能便捷。

imini AI

imini AI

像人一样思考的AI智能体

imini 是一款超级AI智能体,能根据人类指令,自主思考、自主完成、并且交付结果的AI智能体。

Keevx

Keevx

AI数字人视频创作平台

Keevx 一款开箱即用的AI数字人视频创作平台,广泛适用于电商广告、企业培训与社媒宣传,让全球企业与个人创作者无需拍摄剪辑,就能快速生成多语言、高质量的专业视频。

即梦AI

即梦AI

一站式AI创作平台

提供 AI 驱动的图片、视频生成及数字人等功能,助力创意创作

下拉加载更多