出版与作家生涯2016training.talkpython.fm
被误标为回忆录作者,作家发问:谁的作品才算新闻业?
Explore course: Write Pythonic Code Like a Seasoned Developer
导读
这篇帖子介绍的是一门 Python 编程课程,讨论如何写出更地道的 Python 代码,并不是写作或讲故事主题。对写作者而言,可借鉴的是技术写作与教程设计:公开材料、提供好坏对照示例、引用经典参考。若想找 HN 上关于写作的讨论,这篇相关性很低。
可以直接用的写作要点
- 01
写教程时,除了大纲,最好附上可公开访问的材料或经典参考链接,方便读者自学。
- 02
用“好例子 vs 坏例子”的对照来展示风格差异,比抽象规则更易理解。
- 03
示例中的格式细节(如缩进、命名)要保持一致,否则会分散读者对核心观点的注意。
- 04
介绍课程或文章时明确说明哪些内容是公开的,有助于管理读者预期。
HN 评论精选
课程介绍应说明公开范围,并给出经典参考,方便读者延伸学习。
Kennedy 先生,这个课程简介很有意思,看得出你投入了不少工作。课程本身不是公开访问的,但材料是公开的。……(评论还提到 print 语句变函数等 Python 3 特性,并给出一个 PyCon '07 的经典参考链接。)
wyldfire查看英文原文
Mr Kennedy -- this is an interesting course synopsis, it looks like you've put a lot of good work into it. The course itself is not public access, but the materials are. > The few features that are Python 3 specific will be highlighted as such (e.g. new dictionary merging syntax). The print statement=>function is a pretty big one too. IMO it's not too much of a wart to import it from the future in order to straddle 2.x/3.x. Anyone else who came hoping to read actual content on how to write more Pythonic code should consult this popular reference from Pycon '07 [1]. [1] http://python.net/~goodger/projects/pycon/2007/idiomatic/handout.html
示例代码的格式一致性会影响读者理解,教程写作要注意细节。
在“字典作为 switch 语句”的示例里,为什么 @staticmethod 装饰器和它包装的方法缩进层级不同?
RodericDay查看英文原文
In the "Dictionary as a Switch Statement" example, how come the @staticmethod decorator is on a different indent level than the method it wraps?
教程配好坏对照样例,学习效果更好。
如果能在页面上加一些典型代码样例——好与坏的对照——会更好。
limeyy查看英文原文
Would be good to add some of these typical code samples on that page. Good vs bad.
同类还值得读
写书:值得吗?
Writing a book: is it worth it?
Martin Kleppmann(《设计数据密集型应用》作者)复盘写书到底值不值:金钱回报低、耗时极长,但带来了可见度、信任和职业机会。
出版与作家生涯2020 · 642 分 · 287 评4 条写作要点编辑精选写书并不是个好主意
Writing books is not really a good idea
这篇文章讨论靠写书谋生的现实难度,评论区从版税数学、收入预期和写作目标三个角度补充了作者视角。
出版与作家生涯2021 · 577 分 · 609 评4 条写作要点编辑精选如何自助出版一本书:实用资源清单
How to self-publish a book: A handy list of resources
这是一份关于「如何自助出版一本书」的资源清单帖,涵盖从编辑、排版到 ISBN、销售渠道的实操工具与花费。
出版与作家生涯2018 · 558 分 · 88 评4 条写作要点编辑精选我自助出版一本Ruby on Rails书,赚了7万美元
How I Made $70k Self-Publishing a Book about Ruby on Rails
这是一篇 Ruby 开发者自述:他把一套 Rails 性能课程(书+视频+答疑)自出版,一年毛收入约 7 万美元,并总结了选题、定价、营销等经验。
出版与作家生涯2017 · 539 分 · 175 评4 条写作要点编辑精选石黑一雄警告年轻作家因“恐惧”而自我审查
Sir Kazuo Ishiguro warns of young authors self-censoring out of 'fear'
石黑一雄提醒年轻作者因“恐惧”而自我审查,即这条帖子讨论的核心。
出版与作家生涯2021 · 396 分 · 641 评5 条写作要点编辑精选