Skip to content

CLAUDE.md

Latest commit

 

History

History
188 lines (138 loc) · 5.82 KB

CLAUDE.md

File metadata and controls

188 lines (138 loc) · 5.82 KB

C++ 中文周刊 写作风格指南

项目概述

C++ 中文周刊，从 reddit/hackernews/lobsters/meetingcpp 等渠道摘选 C++ 相关文章，用中文进行总结点评。目前已更新 196 期。每期覆盖：资讯、文章、视频、开源项目介绍。

整体风格定位

有人味、接地气、技术硬核但不端着。 不是学术翻译，是一个老C++程序员给同行写的技术八卦周报。

文章结构模板

每期固定结构（参考 posts/template.md）：

---
layout: post
title:  第NNN期
---
# C++ 中文周刊 YYYY-MM-DD 第NNN期

[固定头部：项目地址、公众号二维码、qq群、RSS链接、投稿说明]
[赞助致谢（如有）]

---

## 资讯
标准委员会动态/编译器/IDE信息

## 文章
### [文章标题](原文链接)
中文总结 + 代码 + 点评

## 视频
### [视频标题](链接)

## 开源项目介绍

## 互动环节（可选）

---
[上一期/本期/下一期 链接]

文章总结写法核心原则

1. 保留原始代码，大段贴

这是本周刊的核心卖点。代码一定要保留，而且尽可能完整。读者来看周刊就是想看代码的，不要只写文字描述。

  • 关键代码段要完整贴出（不要省略号代替）
  • 对比性质的代码（优化前后、传统写法vs现代写法）都要给出
  • 如果原文代码太长，选最精华的部分，但宁多勿少
  • 代码块用 ````cpp` 标记

2. 中文总结要精炼有力

  • 先一句话概括文章在讲什么（让人快速判断要不要细看）
  • 用加粗标题分段，如 **背景设定：**、**解决方案：**、**核心观点：**
  • 技术细节用条目列表，不要写大段落
  • 专业术语保留英文，如 UB、RAII、CRTP、SIMD，不要强行翻译

3. 点评要有人味，风趣幽默

这是本周刊区别于机器翻译的灵魂所在。点评风格参考：

口语化、接地气的表达：

  • "省流：可以"
  • "我谢谢你"
  • "又是WinAPI，我看不懂不多逼逼"
  • "家人们还是看看远处的boost实现吧"
  • "胖友们帮帮忙"
  • "embed赶紧来吧"
  • "花里胡哨用处不大"
  • "用户会暴动"
  • "简直不忍直视"
  • "直接打脸"

自嘲/吐槽类：

  • "我记得gcc也有一个类似的找不到了"
  • "悲报，我尝试了一下claude整理周刊，发现比我写的快很多。本周刊正式自动化"
  • "我又被替代了"
  • "值得复现一下（我没看）"

辛辣点评时政/行业：

  • "要我说这就是美帝不行的原因，从上到下都没有耐性我靠"
  • "就像个想离婚的在这里埋怨不想过了，死鬼你也不改你看人家xx语言"

对文章质量的直接评价：

  • "值得一看"
  • "值得复现一下"
  • "感兴趣的可以点进去看看"
  • "了解一下还是可以的。抽象程度很高"
  • "真心贵"

4. 加粗与排版

  • 关键概念、核心结论用 加粗
  • 段落用 **标题：** 做小节分隔
  • 数字、性能数据要突出，如 "23倍加速"
  • 对比数据用箭头："180s → 7.8s"

5. 不同类型文章的处理策略

深度技术文章（如协程实现、性能优化）：

  • 完整展现技术推导过程
  • 代码要大段保留
  • 用加粗标题分步骤讲
  • 最后给"Key takeaways"式总结

知识性短文（如 tip of the week）：

  • 直接贴代码
  • 一两句话点评够了
  • "记住这段代码就行了"

工具/库介绍：

  • 简要说明用途
  • 给个最小示例代码
  • 附上 GitHub 链接

争议/吐槽类（如白宫发文、UB讨论）：

  • 可以多发挥个人观点
  • 吐槽要有趣但不要太过分
  • 该说"我看不懂"就说

Windows API / 不熟悉的领域：

  • 诚实说"看不懂不多逼逼"
  • 不要强行总结不懂的东西

6. 读者评论/投稿内容

  • 标注投稿人："YexuanXiao 投稿"
  • 补充信息以引用或说明形式给出
  • 评论区有价值的讨论也要收录

语言规范

用词习惯

  • 用"简单来说"而不是"总之"
  • 用"其实就是"解释复杂概念
  • 用"显然"引出推导
  • 用"考虑一种场景"引出问题
  • 中英文混排时英文前后不加空格（随意即可）
  • 标准名词用英文：range-based for、expression template、coroutine
  • 尽量口语化，避免"上述"、"综上所述"、"鉴于此"等论文腔

标点符号

  • 中文标点为主
  • 代码内用英文标点
  • 破折号用中文"——"
  • 问号可以多用，制造对话感："这点东西不应该卡啊"

避免的写法

  • ❌ 不要写"本文介绍了xxx，让我们来看看" — 太官方
  • ❌ 不要写"总结：" — 太教科书
  • ❌ 不要所有文章都用一样的开头模式
  • ❌ 不要把每篇文章都写成同样长度，短文就简短处理
  • ❌ 不要过度翻译 — 有些概念英文更清晰就用英文

AI 协助写作注意事项（190期起）

从第190期开始引入 AI（Claude）辅助整理，但要注意：

  1. 保持人味 — AI 总结后必须加入个人点评和口语化表达，不能全篇都是AI味
  2. 代码完整性 — AI 可能会省略代码，要确保关键代码都保留
  3. 不要过度总结 — AI 倾向于写"总结"和"结论"段落，适度即可
  4. 吐槽不能丢 — 哪怕AI写的很全面，也要加入吐槽/点评让文章有温度
  5. 篇幅控制 — AI 写的可能太长，该短的短，该详的详，不要所有文章一样篇幅

特殊栏目说明

开源项目介绍

  • asteria 是固定项目，长期招人
  • 新项目/版本更新简要说明即可
  • 附上 GitHub 链接

热门库更新

  • 列出 commit 链接
  • 涵盖 seastar、folly、fmt、brpc、async_simple 等

赞助致谢

  • 有赞助商时在头部致谢
  • 风格随意，如"他们送了我好多书，在此表示感谢"

文件命名

  • 每期文件：posts/NNN.md（三位数字，如 001.md、196.md）
  • 新一期从 template.md 复制，替换 NNN、日期等占位符