#radar #cli #source #visualize #own #human-readable #tech-radar

app build-your-own-radar-as-code

用代码构建你的技术雷达。编写易于阅读的条目,并使用 tw 开源雷达进行可视化。

2 个不稳定版本

0.2.0 2021年4月7日
0.1.0 2021年2月18日

#13 in #radar

Apache-2.0

13KB
169

构建自己的雷达代码

Thoughtworks 技术雷达是传播知识、可视化熵度和对齐团队的一种好方法。

有几个人提倡公司实施自己的内部雷达,这可以是一个简单的任务,前提是有一个简单的 Thoughtworks 构建-自己的雷达网站,该网站由谷歌表格提供数据。一些公司也实施了他们自己的代码来构建雷达。

然而,所有这些显然都集中在可视化/创建过程上,而不是在共享知识/以包容和迭代的方式构建雷达的过程中。

这里有一些实验,将 GitHub 作为雷达的可编辑源,并利用拉取请求、管道、快照、发布以及当然还有 GitHub 页面的所有优点;)。

有关知识分享和以往经验的个人额外思考,请查看这篇博客文章

build-your-own-radar-as-code

条目格式

条目被描述为 Markdown 文件,以便于在源代码中进行人类可读性和易于维护。

为了提供额外的元数据,例如象限和环,使用了 jenkyl 静态页面中使用的 front matter 模式。front matter 模式简单地说就是文件开头的一个小节,其中包含所需元数据,格式为 yaml,后面是包含完整文本的主体 [jenkyll 示例](https://raw.githubusercontent. com/jekyll/jekyll/master/docs/_posts/2020-12-14-jekyll-4-2-0-released.markdown)。

待办事项

  • 将新的条目文档连接到主文档
  • 使二进制文件易于安装
  • 类型错误?
  • Markdown 到 HTML 转换器
  • 将测试移动到不同的区域
  • 为条目文档的前置元数据创建内部结构
  • 通过切片和对象生命周期减少 String 对象?

依赖项

~9MB
~151K SLoC