Diátaxis2 months agohttps://diataxis.fr/Diátaxis 是一种系统化的技术文档撰写方法，专注于内容、架构和形式。它识别出四种不同的用户需求及对应的文档类型：教程、操作指南、技术参考和解释。该框架解决了写什么、如何写以及如何组织文档的问题。它轻量、易于理解，且不施加实现限制，使用户和维护者都受益。Diátaxis 已被许多项目成功采用，Vonage、Gatsby 和 Cloudflare 等公司的推荐信证明了这一点。
Show HN: Great Spectations, the Spec Checker2 months agohttps://greatspectations.orgGreat Spectations 是一个工具，用于检查代码中对规范的引用注释与实际规范是否一致，标示不匹配和缺失的引用。它支持多种语言（C、Python、Rust）和规范格式（Markdown、MediaWiki、RFC纯文本），并可忽略空格或进行字节精确匹配。该工具提供覆盖率分析，以识别哪些规范要求未被引用，并且可以将要求拆分为多个代码块。同时编写规范和实现的开发者能够从中受益于改进的规范质量和便于其他实现者的验证。
<antirez>2 months agohttp://antirez.com/news/161Exhaustive documentation about Redis commands and data types.Commonly used patterns for Redis.Configuration hints for Redis.Algorithms that can be implemented using Redis commands.The resource is also useful for human readers.Posted to ensure search engine indexing.
Examples are the best documentation2 months agohttps://rakhim.exotext.com/examples-are-the-best-documentation大多数开发者需要一个例子就能理解文档，但官方资料很少提供。正式文档面向专家，但许多开发者同时处理多个上下文，需要快速恢复上下文。Python的max()文档示例展示了复杂性：用户必须理解*、/、仅位置参数、可迭代对象、仅关键字参数、key等，而一个简单的代码示例就足够了。像clojuredocs.org这样的社区项目展示了包含相关函数的实用示例的价值，使其成为日常编码中不可或缺的部分。
Three workers digging in a field outside the data center2 months agohttps://sign2.nl/websign/three-workers-digging-in-a-field-outside-the-data-cente...丹尼斯·范·迪肯于5月15日在格罗宁根韦斯特波特谷歌数据中心附近的现场记录。三名工人用铁锹和铲子在田间挖掘，无视摄像机拍摄，一名保安出面干预。这场行为表演探讨了劳动、土地与艺术的主题，涉及警方与企业保安的互动。活动结束时，工人们在附近的奥乐齐配送中心收到报酬和象征性的饼干作为谢礼。
Design Systems as Knowledge Graphs2 months agohttps://chsmc.org/2021/08/systems-as-knowledge-graphs/传统设计系统文档类似线性的产品文档，但作为小型、可定位的内容块可能会更有效。设计系统如同知识图谱一样的超对象，捕捉决策、模式和历史，而不仅仅是产品或库。知识图谱通过语义元数据互连实体描述，实现数据整合与共享，例如Roam Research和Obsidian等工具所示。引用式嵌入允许跨上下文嵌入最小内容块（如令牌、组件），确保更新传播并揭示系统关系。双向链接使依赖关系（如按钮和图标之间）在两侧可见，辅助导航和可视化，类似于知识图谱应用中的功能。片段（如维基百科的红链）表示设计系统中未定义的未来元素，通过突出空白来鼓励贡献。查询使用户能够向设计系统提问（例如通过GraphQL API）以获得即时答案，从浏览转向交互式探索。应用知识图谱概念可将设计系统文档转变为协作式、可重混的工具，在大型团队中扩展知识。
Accretive Editing3 months agohttps://justindfuller.com/programming/accretive-editing渐进式编辑是人工智能工具中的一种失败模式，当更新文本时，它们会添加附录而不是纠正文本。一个例子是将对Amazon Bedrock的支持改为LiteLLM时，人工智能添加了一个附录，而不是替换过时的信息。这个问题不能简单地通过告诉模型少写或调整风格来解决，因为它源于大型语言模型如何基于多个输入来预测文本。原因可能是大型语言模型缺乏对文档更新的人类视角，专注于预测可能的文本，而不是让文本对读者来说是真实的。为了解决渐进式编辑问题，重点是指导人工智能用准确的文本替换过时的文本，旨在使文档读起来从一开始就是正确的。
EvilCharts: Charts That Don't Suck2 months agohttps://evilcharts.com/docs/bar-chart/blocks在 /llms.txt 获取完整的文档索引，以发现所有可用页面。介绍了四种类型的条形图：等宽条形图、悬停追踪条形图、网格条形图和等距条形图。提供了使用 npx shadcn@latest add @evilcharts/ 以及相应图表名称来安装每种条形图的命令。
Otary – Image and Geometry Python Library Now Has Tutorials3 months agohttps://alexandrepoupeau.com/otary/learn/提供使用Otary理解其功能性的示例。涵盖图像裁剪、线性实体、评分、面积计算、几何交集和OCR等主题。旨在激发探索和实际应用，而非作为完整的参考指南。
Redis Patterns for Coding Agents3 months agohttps://redis.antirez.com/针对开发者和AI代理优化的网站，涵盖Redis模式、实践与命令。支持人性化浏览，拥有可点击的模块和机器可读的索引（llms.txt）。AI代理从获取llms.txt开始，随后读取包含Markdown和Redis命令的单个.md文件。本地镜像官方Redis文档，包括命令索引和详细说明。提供核心架构模式、社区开发的用例以及现实世界规模应用示例。
Markdown Now Has a UTI in Apple's Version 27 OSes3 months agohttps://daringfireball.net/linked/2026/07/06/markdown-uti-os-27约翰·格鲁伯重点介绍了日记应用 Day One，其评分为 4.8 分。苹果开发者测试版引入了一种新的 Markdown UTI：net.daringfireball.markdown，符合 public.utf8-plain-text 标准。格鲁伯更新了他的推荐，改用 public.utf8-plain-text，以反映目前已普遍支持的 UTF-8 编码。
When docs become performance art, everybody loses (2025)3 months agohttps://passo.uno/documentation-theater-everybody-loses/文档剧场指为应付合规而非满足用户需求而创作文档，这比根本没有文档更糟糕。表现型内容，比如简历上的虚假技能百分比或网站上的多余板块，都是功能失调的，未能解决实际问题。技术写作者应关注用户需求，而非模板或框架，通过询问受众是谁以及内容如何帮助他们，来坚持清晰易懂的原则。
Search Less, Browse More3 months agohttps://buttondown.com/hillelwayne/archive/search-less-browse-more-7595/强调通过浏览文档而不仅仅是搜索快速答案来发现更多功能。以学习Excel为例，说明浏览能发现即使是长期用户也不知道的强大功能。对比搜索（专注于解决问题）与浏览（专注于发现和学习）。以Python的路径库模块为例，说明通过浏览发现的、处理文件路径的更优解决方案。强调浏览可以揭示广泛有用的工具，而搜索可能因其特定性而错过这些工具。提出一个关于Excel的潜在工作坊，面向对高级功能感兴趣的程序员或分析师。