TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: Examples of good technical writing?

298 pointsby u385639almost 3 years ago
I wonder if HN could share their favorite pieces of technical writing?<p>Preferably openly available content so that everyone can access (blogs etc.)<p>Focus is on &quot;overall&quot; score: tone, presentation, etc. as opposed to &quot;very technically advanced&quot; (although advanced examples fully welcome)<p>EDIT: awesome suggestions so far - should add that it doesn&#x27;t have to be programming or even computer related... cookbooks count!

90 comments

wkschwartzalmost 3 years ago
James Gleick‘s “Chaos”[0] (history of chaos theory) and “The Information”[1] (history of information theory) are so beautifully and artfully written you might forget they’re technical. As close as (history of) science writing comes to poetry.<p>A lot drier but top marks for clarity: “Linear Algebra Done Right” by Axler.[2] It got me through both undergraduate and PhD math degrees. When something was confusing in a lecture or another textbook, I could always return to Axler for the most direct path from ignorance to understanding.<p>[0]: <a href="https:&#x2F;&#x2F;www.amazon.com&#x2F;Chaos-Making-Science-James-Gleick&#x2F;dp&#x2F;0143113453" rel="nofollow">https:&#x2F;&#x2F;www.amazon.com&#x2F;Chaos-Making-Science-James-Gleick&#x2F;dp&#x2F;...</a> [1]: <a href="https:&#x2F;&#x2F;www.amazon.com&#x2F;Information-History-Theory-Flood&#x2F;dp&#x2F;1400096235" rel="nofollow">https:&#x2F;&#x2F;www.amazon.com&#x2F;Information-History-Theory-Flood&#x2F;dp&#x2F;1...</a> [2]: <a href="https:&#x2F;&#x2F;linear.axler.net&#x2F;" rel="nofollow">https:&#x2F;&#x2F;linear.axler.net&#x2F;</a>
评论 #31642434 未加载
评论 #31635618 未加载
kashyapcalmost 3 years ago
Almost anything written by the inimitable LWN.net[1] — their feature-length articles, technical conference coverage, etc. Something that springs immediately to mind is their 7-part series[2] Linux kernel namespaces from 2013. The full series is linked to at the bottom of part 1:<p>- <i>Namespaces in operation, part 1: namespaces overview — <a href="https:&#x2F;&#x2F;lwn.net&#x2F;Articles&#x2F;531114&#x2F;" rel="nofollow">https:&#x2F;&#x2F;lwn.net&#x2F;Articles&#x2F;531114&#x2F;</a> (2013)</i><p>You can see their entire kernel archives here[3]. And as to their excellent conference coverage, you can browse conferences by year[4]. Most recently, here&#x27;s[5] their roundup of &quot;Linux Storage, Filesystem, Memory-Management and BPF summit&quot;.<p>[1] <a href="https:&#x2F;&#x2F;lwn.net" rel="nofollow">https:&#x2F;&#x2F;lwn.net</a><p>[2] <a href="https:&#x2F;&#x2F;lwn.net&#x2F;Articles&#x2F;531114&#x2F;#series_index" rel="nofollow">https:&#x2F;&#x2F;lwn.net&#x2F;Articles&#x2F;531114&#x2F;#series_index</a><p>[3] <a href="https:&#x2F;&#x2F;lwn.net&#x2F;Kernel&#x2F;" rel="nofollow">https:&#x2F;&#x2F;lwn.net&#x2F;Kernel&#x2F;</a><p>[4] <a href="https:&#x2F;&#x2F;lwn.net&#x2F;Archives&#x2F;ConferenceByYear&#x2F;" rel="nofollow">https:&#x2F;&#x2F;lwn.net&#x2F;Archives&#x2F;ConferenceByYear&#x2F;</a><p>[5] <a href="https:&#x2F;&#x2F;lwn.net&#x2F;Articles&#x2F;lsfmm2022&#x2F;" rel="nofollow">https:&#x2F;&#x2F;lwn.net&#x2F;Articles&#x2F;lsfmm2022&#x2F;</a>
ImageXavalmost 3 years ago
Code: The Hidden Language of Computer Hardware and Software by Charles Petzold is an excellent work that very clearly guides the reader through the components and steps that lead to the sophisticated computer systems we have nowadays. Each step is explained with no logical leaps and could be followed by a young child.<p>Improving almost anything by George Box blew my mind. As children and even as university students we have been lied to. We have been told that experiments must be carried out one at a time to assign effects. This is patently false. In fact, we miss out on potential interaction effects (think temperature and time in cooking) by using one factor at a time experimentation. In this book he discusses many now old but fundamental techniques by which large improvements in models can be gained with minimal data. It has helped me in my career immensely and made me aware of many usual methods and fields of study.
评论 #31633932 未加载
评论 #31697330 未加载
评论 #31635280 未加载
maxiquealmost 3 years ago
Julia Evans&#x27; comics, zines and blog posts are absolutely brilliant. Accessible, educational and full of personality. <a href="https:&#x2F;&#x2F;jvns.ca&#x2F;" rel="nofollow">https:&#x2F;&#x2F;jvns.ca&#x2F;</a>
评论 #31634441 未加载
评论 #31633483 未加载
GrumpyYoungManalmost 3 years ago
K&amp;R (&quot;<i>The C Programming Language</i>&quot;) still stands out, at least to me, for its clarity and conciseness. I have yet to see a programming language manual that equals it.
评论 #31631619 未加载
评论 #31635782 未加载
评论 #31631642 未加载
评论 #31632581 未加载
andrenotgiantalmost 3 years ago
<a href="https:&#x2F;&#x2F;www.prisma.io&#x2F;dataguide&#x2F;" rel="nofollow">https:&#x2F;&#x2F;www.prisma.io&#x2F;dataguide&#x2F;</a><p>Over the past few years, Prisma has been quietly building a complete zero to advanced guide to databases that I&#x27;ve started to refer people to and use as reference myself. It stands out to me because it is focusing on a broader topic than what you typically find in docs, it&#x27;s written simply, it is super comprehensive, and it&#x27;s not trying to sell something.
评论 #31631973 未加载
open-source-uxalmost 3 years ago
Here&#x27;s an unusual suggestion...<p>In the 1980s the children&#x27;s publisher Usborne published computing books for young readers and a few years ago they made the books available for free download. The books use illustrations extensively to explain concepts. Not only are these books well written with clear, concise explanations, they are also more readable and enjoyable than many programming and computing books published for adults today.<p>Anyone writing a technical guide (of any kind) would benefit from reading these as a source of ideas and inspiration:<p><a href="https:&#x2F;&#x2F;usborne.com&#x2F;gb&#x2F;books&#x2F;computer-and-coding-books" rel="nofollow">https:&#x2F;&#x2F;usborne.com&#x2F;gb&#x2F;books&#x2F;computer-and-coding-books</a>
评论 #31631675 未加载
jl6almost 3 years ago
<a href="https:&#x2F;&#x2F;www.postgresql.org&#x2F;docs&#x2F;" rel="nofollow">https:&#x2F;&#x2F;www.postgresql.org&#x2F;docs&#x2F;</a><p>The PostgreSQL documentation is pretty fabulous. It’s well organized, complete, clear, and purposeful. You can read it like a textbook from page 1, or dive into it as a quick reference.
jdminhbgalmost 3 years ago
The docs for re-frame[0], a functional reactive framework for ClojureScript, are really excellent. They do a great job explaining the problem, the rationale for the approach taken, and how to actually use the framework. The library is a gem of of both functionality and documentation.<p>0: <a href="http:&#x2F;&#x2F;day8.github.io&#x2F;re-frame&#x2F;re-frame&#x2F;" rel="nofollow">http:&#x2F;&#x2F;day8.github.io&#x2F;re-frame&#x2F;re-frame&#x2F;</a>
jonahbentonalmost 3 years ago
Some mention of his works here, but not his name<p>Michael Kerrisk<p>Author of the Linux Programming Interface, innumerable man pages, and many other projects.<p>Absolutely, without question, the best longform technical writer. Reading his books, where he gets to exercise all of the skills in terms of sequencing, layering, explanation, repetition, etc is like receiving an architectural download from the universe.<p>Will also like others cite Knuth, whom I used to read just for relaxation that his orderly brain would induce in mine, and Stallman- the technical writings- who for all his flaws was and is an exceptionally gifted explainer.
评论 #31633246 未加载
评论 #31633925 未加载
thethimblealmost 3 years ago
DDIA by Martin Kleppmann is fantastic.<p>Great job of providing low level details contextualized in a high-level narrative. He’s also got these amazing fantasy maps of the fictional landscape of data architecture: <a href="https:&#x2F;&#x2F;martin.kleppmann.com&#x2F;2017&#x2F;03&#x2F;15&#x2F;map-distributed-data-systems.html" rel="nofollow">https:&#x2F;&#x2F;martin.kleppmann.com&#x2F;2017&#x2F;03&#x2F;15&#x2F;map-distributed-data...</a>
mikewarotalmost 3 years ago
I think the Turbo Pascal 3.0 manual[1] was one of the best printed manuals I ever owned. It alone was worth the price of the compiler.<p>One of the most complete (and useful!) books about an area of study I&#x27;ve found is The Art of Electronics[2] by Horowitz and Hill. They point out all the traps that are likely to be encountered by an engineer working with the components as they describe them, along with the various trade-offs.<p>1 - <a href="https:&#x2F;&#x2F;archive.org&#x2F;details&#x2F;bitsavers_borlandturVersion3.0ReferenceManual1986_11515064&#x2F;page&#x2F;n101&#x2F;mode&#x2F;2up" rel="nofollow">https:&#x2F;&#x2F;archive.org&#x2F;details&#x2F;bitsavers_borlandturVersion3.0Re...</a><p>2 - <a href="https:&#x2F;&#x2F;artofelectronics.net&#x2F;" rel="nofollow">https:&#x2F;&#x2F;artofelectronics.net&#x2F;</a>
评论 #31634222 未加载
评论 #31635073 未加载
subsection1halmost 3 years ago
Apple Style Guide <a href="https:&#x2F;&#x2F;help.apple.com&#x2F;applestyleguide&#x2F;" rel="nofollow">https:&#x2F;&#x2F;help.apple.com&#x2F;applestyleguide&#x2F;</a><p>Google Developer Documentation Style Guide <a href="https:&#x2F;&#x2F;developers.google.com&#x2F;style&#x2F;" rel="nofollow">https:&#x2F;&#x2F;developers.google.com&#x2F;style&#x2F;</a><p>Microsoft Style Guide <a href="https:&#x2F;&#x2F;docs.microsoft.com&#x2F;en-us&#x2F;style-guide&#x2F;welcome&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.microsoft.com&#x2F;en-us&#x2F;style-guide&#x2F;welcome&#x2F;</a>
nobozoalmost 3 years ago
Anything that Ken Shirriff writes (<a href="http:&#x2F;&#x2F;www.righto.com&#x2F;" rel="nofollow">http:&#x2F;&#x2F;www.righto.com&#x2F;</a>) is excellent. He&#x27;s a UC Berkeley EE&#x2F;CS PhD who likes to restore and reverse engineer interesting hardware. His writing is so clear.<p>(minor disclosure - I worked in the CS department at UCB when he was a PhD student but I didn&#x27;t really know him, and I strongly doubt he remembers me.)
onychomysalmost 3 years ago
D&#x27;arcy Wentworth Thompson wrote what is widely considered to be the most beautiful book in biology, and thankfully he wrote it long enough ago that it&#x27;s now in the public domain. Every sentence is like a little poem.<p><a href="https:&#x2F;&#x2F;gutenberg.org&#x2F;ebooks&#x2F;55264" rel="nofollow">https:&#x2F;&#x2F;gutenberg.org&#x2F;ebooks&#x2F;55264</a>
评论 #31631643 未加载
tyingqalmost 3 years ago
Sqlite has some good documentation. Their explanation of the file format is a good example:<p><a href="https:&#x2F;&#x2F;www.sqlite.org&#x2F;fileformat.html" rel="nofollow">https:&#x2F;&#x2F;www.sqlite.org&#x2F;fileformat.html</a><p>Much better than other file format docs I&#x27;ve read, covers almost all the corner cases well, broken up into logical sections, uses tables for data formats when that makes sense, etc.
ipnonalmost 3 years ago
Concrete Mathematics: A Foundation for Computer Science, by Ronald Graham, Donald Knuth, and Oren Patashnik, is the rare example of a textbook that is entirely useful, enlightening, and hilarious all at once.
评论 #31633464 未加载
rmckayflemingalmost 3 years ago
Common Lisp the Language: 2nd Edition by Guy Steele. It&#x27;s a bit hard to come by as a physical copy (I ordered mine from Abe Books), but it&#x27;s a fantastic example of technical writing in many facets. I pretty much read it cover to cover (skimming over some of the more reference-y material).<p>What I found particularly unique about it was the way it highlighted changes made to the language since the first edition. Instead of having a notes section at the back or asides scattered throughout, it&#x27;s structured like a redlined document (although much easier to read). Paragraphs that are no longer relevant are marked with a dotted vertical line in the margin, while additions are marked with a solid vertical line. Typically you&#x27;ll see a removed section immediately followed by an addition that&#x27;ll note something to the effect of &quot;X3J13 voted to remove this from the language in July 1988...&quot; and it&#x27;ll go on to explain why that happened. Reading about all of the votes really hammered home the fact that Common Lisp was a compromise between many different organizations and dialects. So not only did it help me better understand Common Lisp, it helped me appreciate why Common Lisp is the way it is.
ddvalmost 3 years ago
<a href="https:&#x2F;&#x2F;ciechanow.ski&#x2F;gps&#x2F;" rel="nofollow">https:&#x2F;&#x2F;ciechanow.ski&#x2F;gps&#x2F;</a><p><a href="https:&#x2F;&#x2F;ciechanow.ski&#x2F;archives&#x2F;" rel="nofollow">https:&#x2F;&#x2F;ciechanow.ski&#x2F;archives&#x2F;</a>
评论 #31636960 未加载
vehemenzalmost 3 years ago
I am a fan of PHP&#x27;s official documentation. It&#x27;s well organized, terse, and relies heavily on exemplification.<p>As a bonus, you get more examples in the comments—kind of like Stack Overflow, but attached to a particular feature or process of PHP.
评论 #31635416 未加载
TaylorAlexanderalmost 3 years ago
Well, it is a novel rather than what you would typically consider &quot;technical writing&quot;, but the book &quot;The Martian&quot; was written by an engineer and is chock full of technical stuff with a very engaging presentation! I don&#x27;t normally read books, but that one I could not put down and I read the whole thing in a week, which is very fast for me.
evolve2kalmost 3 years ago
I very much enjoyed this comprehensive piece on UTC and handling time in code by Zach Holman<p><a href="https:&#x2F;&#x2F;zachholman.com&#x2F;talk&#x2F;utc-is-enough-for-everyone-right" rel="nofollow">https:&#x2F;&#x2F;zachholman.com&#x2F;talk&#x2F;utc-is-enough-for-everyone-right</a>
randcrawalmost 3 years ago
Anything by Bill Bryson, but especially “At Home” and “One Summer: America, 1927”. Both are brilliant.<p>“John Adams” by David McCullough. Possibly the best historical bio ever.<p>“The Making of the Atomic Bomb” by Richard Rhodes. The best recounting of the founding of Los Alamos.<p>“Hackers” by Steven Levy. The best book on the birth of creatine coding.<p>“The Soul of a New Machine” by Tracy Kidder. The best tale of hardware design I know.<p>“Masters of Doom” by David Kushner. The best book on the early days of gaming, esp. about Carmack and Romero.<p>Anything by Eric Raymond, esp. “The Cathedral and the Bazaar”.
评论 #31634503 未加载
评论 #31635820 未加载
评论 #31635160 未加载
bumbledravenalmost 3 years ago
I always thought TCP&#x2F;IP Illustrated by W. Richard Stevens was very clearly written. <a href="https:&#x2F;&#x2F;en.wikipedia.org&#x2F;wiki&#x2F;TCP&#x2F;IP_Illustrated" rel="nofollow">https:&#x2F;&#x2F;en.wikipedia.org&#x2F;wiki&#x2F;TCP&#x2F;IP_Illustrated</a>
wheybagsalmost 3 years ago
&quot;The old new thing&quot; blog by Raymond Chen at Microsoft: <a href="https:&#x2F;&#x2F;devblogs.microsoft.com&#x2F;oldnewthing&#x2F;" rel="nofollow">https:&#x2F;&#x2F;devblogs.microsoft.com&#x2F;oldnewthing&#x2F;</a><p>Random good example post: <a href="https:&#x2F;&#x2F;devblogs.microsoft.com&#x2F;oldnewthing&#x2F;20220328-00&#x2F;?p=106401" rel="nofollow">https:&#x2F;&#x2F;devblogs.microsoft.com&#x2F;oldnewthing&#x2F;20220328-00&#x2F;?p=10...</a><p>To me, it&#x27;s representative of all the good bits of Microsoft, now, and also in the past. I wish they had more Raymond Chens, and less... whoever it is driving their focus on crappy adware, telemetry, bad &quot;modernized ux&quot;, user hostile behaviour in general.
cehrlichalmost 3 years ago
The Django documentation is outstanding. Django was my first time doing web programming, and the docs both got me up and running in no time, and also repeatedly surprised me by having easy to understand answers to whatever obscure thing I wanted to know.
eveningtreealmost 3 years ago
<a href="https:&#x2F;&#x2F;poignant.guide&#x2F;" rel="nofollow">https:&#x2F;&#x2F;poignant.guide&#x2F;</a><p>&quot;why&#x27;s (poignant) Guide to Ruby&quot;<p>All right, this one is not purely technical. It&#x27;s technical, but mixed with comics, art and a lot of personality.<p>It is an old classic in the community, and something that I aim up towards. Opened up my imagination to what a unique thing a technical book can become.
prometheus76almost 3 years ago
How to Keep Your Volkswagen Alive: A Manual of Step-by-Step Procedures for the Compleat Idiot by John Muir and Tosh Gregg..<p>This book was originally published in 1969 and assumes you know nothing about cars or mechanical systems. They do a great job of getting the reader up to speed quickly without moving too fast or leaving out important concepts.<p>I was introduced to the book by my high school English teacher. He used it as an example of fine technical writing that doesn&#x27;t feel like technical writing. I enjoyed the chapter he shared with us so much that I bought the book and read the whole thing. It&#x27;s a great manual!
SPBSalmost 3 years ago
I look up to <a href="https:&#x2F;&#x2F;sqlite.org&#x2F;lpc2019&#x2F;doc&#x2F;trunk&#x2F;briefing.md" rel="nofollow">https:&#x2F;&#x2F;sqlite.org&#x2F;lpc2019&#x2F;doc&#x2F;trunk&#x2F;briefing.md</a> (discussed at <a href="https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=25167423" rel="nofollow">https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=25167423</a>) as an example of how to talk about something very technical with simple bullet points. I barely understand 10% of what is written but it is very easy to scan and read.
ternaryoperatoralmost 3 years ago
Most anything by Bob Nystrom. Some (all?) of his books are available for free on the Web. I recommend starting with Crafting Interpreters.
评论 #31637480 未加载
kqr2almost 3 years ago
Forrest Mims III books on electronics are considered classics in teaching electronics:<p><a href="https:&#x2F;&#x2F;boingboing.net&#x2F;2020&#x2F;08&#x2F;31&#x2F;getting-started-in-electronics.html" rel="nofollow">https:&#x2F;&#x2F;boingboing.net&#x2F;2020&#x2F;08&#x2F;31&#x2F;getting-started-in-electro...</a><p><a href="https:&#x2F;&#x2F;www.forrestmims.com&#x2F;" rel="nofollow">https:&#x2F;&#x2F;www.forrestmims.com&#x2F;</a>
behnamohalmost 3 years ago
Racket’s documentation is really nice:<p><a href="https:&#x2F;&#x2F;docs.racket-lang.org&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.racket-lang.org&#x2F;</a>
bonobocopalmost 3 years ago
I think some of the best technical writing I&#x27;ve enjoyed is: <a href="https:&#x2F;&#x2F;aws.amazon.com&#x2F;builders-library&#x2F;" rel="nofollow">https:&#x2F;&#x2F;aws.amazon.com&#x2F;builders-library&#x2F;</a><p>Clear and concise articles that really dig into some of the hard technical problems with working at scale.<p>Has honestly made me a much better systems programmer since starting to read them.
phamiltonalmost 3 years ago
<a href="https:&#x2F;&#x2F;docs.microsoft.com&#x2F;en-us&#x2F;azure&#x2F;architecture&#x2F;patterns&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.microsoft.com&#x2F;en-us&#x2F;azure&#x2F;architecture&#x2F;patterns...</a> is an absolute gem. Each article balances between theory and examples and ties it to Azure without getting in the way of the underlying concept.
CalChrisalmost 3 years ago
Anything by Rachel Carson.<p>Anything by Donald Knuth. He even teaches good writing in <i>Mathematical Writing</i>.<p>I always thought IBM held a high standard for their writing. So anything from the <i>IBM System&#x2F;370 Principles of Operation</i> to their <i>IBM Journal of Research and Development</i> would be good.<p>Lately, I&#x27;ve been reading <i>Algorithms</i> by Dasgupta, et al and those boys can write.
kaycebasquesalmost 3 years ago
<i>Rustlings</i> (<a href="https:&#x2F;&#x2F;github.com&#x2F;rust-lang&#x2F;rustlings" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;rust-lang&#x2F;rustlings</a>) - interactivity<p><i>Inside look at modern web browser</i> (<a href="https:&#x2F;&#x2F;developer.chrome.com&#x2F;blog&#x2F;inside-browser-part1&#x2F;" rel="nofollow">https:&#x2F;&#x2F;developer.chrome.com&#x2F;blog&#x2F;inside-browser-part1&#x2F;</a>) - fun illustrations<p><i>Nunjucks</i> (<a href="https:&#x2F;&#x2F;mozilla.github.io&#x2F;nunjucks&#x2F;templating.html" rel="nofollow">https:&#x2F;&#x2F;mozilla.github.io&#x2F;nunjucks&#x2F;templating.html</a>) - easy-to-use site nav<p><i>Vodafone + Core Web Vitals case study</i> (<a href="https:&#x2F;&#x2F;web.dev&#x2F;vodafone&#x2F;" rel="nofollow">https:&#x2F;&#x2F;web.dev&#x2F;vodafone&#x2F;</a>) - packed with info and no marketing BS (disclosure: I was majorly involved in that content)
endgamealmost 3 years ago
On the meta level, Zissner&#x27;s &quot;On Writing Well&quot; is excellent. The book is enjoyable to read which proves that he knew what he was writing about, and it makes a very strong case that whenever you&#x27;re writing, it&#x27;s worth the effort to do it well.
layer8almost 3 years ago
I recently got my hands on an old Turbo C manual, and I miss that kind of technical documentation that actually explained everything from the ground up. See for example Figure 2.2: A Sample Use of Hot Keys in <a href="http:&#x2F;&#x2F;bitsavers.informatik.uni-stuttgart.de&#x2F;pdf&#x2F;borland&#x2F;turbo_c&#x2F;Turbo_C_Users_Guide_1987.pdf" rel="nofollow">http:&#x2F;&#x2F;bitsavers.informatik.uni-stuttgart.de&#x2F;pdf&#x2F;borland&#x2F;tur...</a><p>Here is another example, the manual for Microsoft Word 1.0 for DOS: <a href="http:&#x2F;&#x2F;toastytech.com&#x2F;manuals&#x2F;MS%20Word%201.00%20for%20DOS%20Manual.pdf" rel="nofollow">http:&#x2F;&#x2F;toastytech.com&#x2F;manuals&#x2F;MS%20Word%201.00%20for%20DOS%2...</a>
xahrepapalmost 3 years ago
I don’t have time to expound too much, but I really love America’s Test Kitchen’s two Gluten Free books “The How Can It Be Gluten Free Cookbook” volumes 1 and 2.<p>Every recipe we’ve tried have been great. But the reason I wanted to share it here is how ATK analyses and shares how they decide the best ingredients for different recipes. Gluten is a very important (and more nuanced than I realized) ingredient in traditional cooking and baking. So when you remove it there are a lot of surprising effects. (And some unsurprising ones). So ATK takes you through those nuances.<p>It’s really fun to learn and I’m not much of a cook myself :)
lb1lfalmost 3 years ago
Lots of old Analog Devices app notes are masterpieces of concise technical writing.<p>Also, their &#x27;Analog Dialog&#x27; series [0] are quite something.<p>Edit: HP, too, made some excellent tech notes back in the day.<p>[0] <a href="https:&#x2F;&#x2F;web.ece.ucsb.edu&#x2F;~ilan&#x2F;Classes&#x2F;ECE2A_F2010&#x2F;Tutorials&#x2F;App%20notes&#x2F;Analog%20Dialog.pdf" rel="nofollow">https:&#x2F;&#x2F;web.ece.ucsb.edu&#x2F;~ilan&#x2F;Classes&#x2F;ECE2A_F2010&#x2F;Tutorials...</a>
spaetzleesseralmost 3 years ago
Stroustrup&#x27;s C++ books are great. You can read them like a regular book. Scott Meyer&#x27;s books read well. Kernighan &amp; Ritchie&#x27;s C book is very good. Mac OS documentation in the 1990&#x27;s was excellent.<p>I feel there has been a decline in the quality of tech writing since the internet became popular. Today&#x27;s books are often extremely verbose while not conveying content well.
eternalbanalmost 3 years ago
<a href="https:&#x2F;&#x2F;zguide.zeromq.org&#x2F;" rel="nofollow">https:&#x2F;&#x2F;zguide.zeromq.org&#x2F;</a><p>[p.s. RIP Pieter -&gt; Read this: <a href="https:&#x2F;&#x2F;web.archive.org&#x2F;web&#x2F;20090420070511&#x2F;http:&#x2F;&#x2F;www.digistan.org&#x2F;spec:1" rel="nofollow">https:&#x2F;&#x2F;web.archive.org&#x2F;web&#x2F;20090420070511&#x2F;http:&#x2F;&#x2F;www.digist...</a>]
simonwalmost 3 years ago
I thoroughly enjoyed the README for the just tool the other day - very thorough, answered all of my questions, fun to read: <a href="https:&#x2F;&#x2F;github.com&#x2F;casey&#x2F;just&#x2F;blob&#x2F;master&#x2F;README.md" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;casey&#x2F;just&#x2F;blob&#x2F;master&#x2F;README.md</a>
gaudatalmost 3 years ago
Not quite software development related but check out the application notes and articles from Jim Williams and Bob Pease.
thangalinalmost 3 years ago
On a related note, Diana Reep&#x27;s &quot;Technical Writing: Principles, Strategies, and Readings&quot; is outstanding.<p><a href="https:&#x2F;&#x2F;www.amazon.com&#x2F;Technical-Writing-Principles-Strategies-Readings&#x2F;dp&#x2F;0205721508" rel="nofollow">https:&#x2F;&#x2F;www.amazon.com&#x2F;Technical-Writing-Principles-Strategi...</a>
belfalasalmost 3 years ago
I have always found SQLite to have fantastic documentation. Very clear writing. <a href="https:&#x2F;&#x2F;www.sqlite.org&#x2F;docs.html" rel="nofollow">https:&#x2F;&#x2F;www.sqlite.org&#x2F;docs.html</a><p>Back in the heydays of Ruby on Rails I also found the Net::SSH library by Jamis Buck to be very excellent in terms of documentation.
ravish0007almost 3 years ago
Knuth&#x27;s Literate programming, or maybe his work in general<p>Eloquentjavascript<p>Gentoo Handbook + Arch wiki<p>SICP &lt;3<p>ESR&#x27;s blog
sirpiladealmost 3 years ago
Learning Perl by Randal Schwartz[1] was the funniest programming book I ever read. I must give credit to this book if I enjoyed so much programming perl<p>[1] <a href="https:&#x2F;&#x2F;en.wikipedia.org&#x2F;wiki&#x2F;Learning_Perl" rel="nofollow">https:&#x2F;&#x2F;en.wikipedia.org&#x2F;wiki&#x2F;Learning_Perl</a>
评论 #31634544 未加载
xupybdalmost 3 years ago
I&#x27;ve been learning F# and the docs are the best I&#x27;ve read.<p>The Emlish book is great. <a href="https:&#x2F;&#x2F;zaid-ajaj.github.io&#x2F;the-elmish-book&#x2F;#&#x2F;" rel="nofollow">https:&#x2F;&#x2F;zaid-ajaj.github.io&#x2F;the-elmish-book&#x2F;#&#x2F;</a><p>Domain Modeling Made Functional: Tackle Software Complexity with Domain-Driven Design and F# Book by Scott Wlaschin is amazing. His blog is also fantastic.<a href="https:&#x2F;&#x2F;fsharpforfunandprofit.com&#x2F;" rel="nofollow">https:&#x2F;&#x2F;fsharpforfunandprofit.com&#x2F;</a><p>Get Programming with F# A guide for .NET developers by Isaac Abraham is also very good.<p>Not F# but the best written technical book I&#x27;ve read has to be The Pragmatic Programmer Book by Andy Hunt and Dave Thomas.<p>An example of making a boring technical topic into an engaging novel is The Goal Novel by Eliyahu M. Goldratt
shireboyalmost 3 years ago
A bit dated, but .NET Framework Design Guidelines is one that came to mind. I read it ages ago, and its content has since been baked into static analysis tools and ides, but at the time as a younger dev I greatly appreciated the prescriptive simple style. “Do, Don’t, Consider” plain English rules, just enough explanation to help understand the rule, and a simple code example. Maybe I’m just weird, but I often think that this style is a good fit for a number of technical areas. I could see for cooking for example, providing similar might help people unsure about the “rules”.<p><a href="https:&#x2F;&#x2F;www.goodreads.com&#x2F;book&#x2F;show&#x2F;2700831-framework-design-guidelines" rel="nofollow">https:&#x2F;&#x2F;www.goodreads.com&#x2F;book&#x2F;show&#x2F;2700831-framework-design...</a>
izhakalmost 3 years ago
All W. Richard Stevens books.
pyjarrettalmost 3 years ago
Physically Based Rendering by Matt Pharr, et. al.<p>It&#x27;s an entire ray-tracer explained in the literate programming style.
rramadassalmost 3 years ago
A couple of my favourites are;<p>* <i>Introductory Logic and Sets for Computer Scientists.</i><p>* <i>Formal Specification: Techniques and Applications.</i><p>both by Nimal Nissanke.<p>The writing is Precise, Succinct, Clear with lots of examples. A wide variety of topics are explained without overwhelming the reader and all within a decent-sized book.
pyuser583almost 3 years ago
A lot of technical writing is on obscure, proprietary topics. It’s about making the boring and complex become easily understandable, but not necessarily interesting.<p>For example, the “HP ProBook 470 G5 Notebook PC: Maintenance and Service Guide” has an excellent reputation.<p>If your looking for something a bit more interesting, I suggest Mitigating Attacks on Houses of Worship by CISA: <a href="https:&#x2F;&#x2F;www.cisa.gov&#x2F;sites&#x2F;default&#x2F;files&#x2F;publications&#x2F;Mitigating%20Attacks%20on%20Houses%20of%20Worship%20Security%20Guide_508.pdf" rel="nofollow">https:&#x2F;&#x2F;www.cisa.gov&#x2F;sites&#x2F;default&#x2F;files&#x2F;publications&#x2F;Mitiga...</a>
GartzenDeHaesalmost 3 years ago
Starting Forth, if you like a conversational style. As others have said, K&amp;R C for conciseness.<p><a href="https:&#x2F;&#x2F;www.forth.com&#x2F;starting-forth&#x2F;" rel="nofollow">https:&#x2F;&#x2F;www.forth.com&#x2F;starting-forth&#x2F;</a> (PDF)
评论 #31636169 未加载
fordalmost 3 years ago
This isn&#x27;t exactly what you&#x27;re looking for, but I found this course [0] from google useful.<p>[0] <a href="https:&#x2F;&#x2F;developers.google.com&#x2F;tech-writing" rel="nofollow">https:&#x2F;&#x2F;developers.google.com&#x2F;tech-writing</a>
rozenmdalmost 3 years ago
I&#x27;m often told my React explainers at <a href="https:&#x2F;&#x2F;maxrozen.com&#x2F;articles" rel="nofollow">https:&#x2F;&#x2F;maxrozen.com&#x2F;articles</a> are very accessible (particularly for non native English speakers)
wunderlustalmost 3 years ago
It’s a stretch but I’d say a lot of modern analytical philosophy could be considered “technical” in the sense that the convention is to articulate ideas and arguments as clearly and precisely as possible.<p>My recommendations would be Hilary Putnam, Nelson Goodman, and W.V.O Quine.<p>A paper I’m currently reading, which was seminal in phenomenology, is “ The Phenomenology of Cognition: Or What Is It Like to Think That P?”[1] by David Pitt. Really nice example of a well-formed thesis.<p>[1] <a href="https:&#x2F;&#x2F;philpapers.org&#x2F;rec&#x2F;PITWII" rel="nofollow">https:&#x2F;&#x2F;philpapers.org&#x2F;rec&#x2F;PITWII</a>
评论 #31634598 未加载
评论 #31634681 未加载
hlesesnealmost 3 years ago
CERNs OpenStack documentation is pretty terrific. Wish for profit cloud providers had as good.<p><a href="https:&#x2F;&#x2F;clouddocs.web.cern.ch&#x2F;" rel="nofollow">https:&#x2F;&#x2F;clouddocs.web.cern.ch&#x2F;</a>
AdieuToLogicalmost 3 years ago
FreeBSD: <a href="https:&#x2F;&#x2F;docs.freebsd.org&#x2F;en&#x2F;books&#x2F;handbook&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.freebsd.org&#x2F;en&#x2F;books&#x2F;handbook&#x2F;</a>
layer8almost 3 years ago
The Perl man pages are great: <a href="https:&#x2F;&#x2F;linux.die.net&#x2F;man&#x2F;1&#x2F;perl" rel="nofollow">https:&#x2F;&#x2F;linux.die.net&#x2F;man&#x2F;1&#x2F;perl</a>
评论 #31633470 未加载
steppialmost 3 years ago
I&#x27;m very fond of the boost math documentation [0]. Also scikit-learn&#x27;s documentation [1].<p>[0] <a href="https:&#x2F;&#x2F;www.boost.org&#x2F;doc&#x2F;libs&#x2F;1_79_0&#x2F;libs&#x2F;math&#x2F;doc&#x2F;html&#x2F;index.html" rel="nofollow">https:&#x2F;&#x2F;www.boost.org&#x2F;doc&#x2F;libs&#x2F;1_79_0&#x2F;libs&#x2F;math&#x2F;doc&#x2F;html&#x2F;ind...</a><p>[1] <a href="https:&#x2F;&#x2F;scikit-learn.org&#x2F;stable&#x2F;" rel="nofollow">https:&#x2F;&#x2F;scikit-learn.org&#x2F;stable&#x2F;</a>
c0l0almost 3 years ago
I always loved the in-depth nature and clear writing style of the man page of the hwclock(8) program distributed with util-linux(-ng), and happily refer to it as an example of great documentation whenever I get a chance to: <a href="https:&#x2F;&#x2F;www.man7.org&#x2F;linux&#x2F;man-pages&#x2F;man8&#x2F;hwclock.8.html" rel="nofollow">https:&#x2F;&#x2F;www.man7.org&#x2F;linux&#x2F;man-pages&#x2F;man8&#x2F;hwclock.8.html</a>
raddanalmost 3 years ago
This is my favorite CS paper. The writing is clear (almost “simple”), the idea is brilliant, and the entire thing is beautifully presented.<p><a href="https:&#x2F;&#x2F;m-cacm.acm.org&#x2F;magazines&#x2F;2018&#x2F;6&#x2F;228044-coz&#x2F;fulltext" rel="nofollow">https:&#x2F;&#x2F;m-cacm.acm.org&#x2F;magazines&#x2F;2018&#x2F;6&#x2F;228044-coz&#x2F;fulltext</a><p>Full disclosure: I know both authors well so I’m probably a little biased.
thomasfromcdnjsalmost 3 years ago
I recently stumbled upon this. Up there with best technical content I&#x27;ve read, helped align the team immediately -&gt; <a href="https:&#x2F;&#x2F;pencilandpaper.io&#x2F;articles&#x2F;ux-pattern-analysis-enterprise-filtering&#x2F;" rel="nofollow">https:&#x2F;&#x2F;pencilandpaper.io&#x2F;articles&#x2F;ux-pattern-analysis-enter...</a>
lhoffalmost 3 years ago
Not IT related and more scientific then technical but imho it somehow fits your description.<p>Bas Kast: The Diet Compass: The 12-Step Guide to Science-Based Nutrition for a Healthier and Longer Life<p>The title sounds clickbaity but the book isn&#x27;t. Very toned down, unidological description of the curent state of the science in regards to diet and nutrition.
8bitsrulealmost 3 years ago
I always thought Don Lancaster&#x27;s electronic &quot;cookbook&quot; series were top-notch examples of accessible, educational technical writing. Still kicking at &#x27;Guru&#x27;s Lair&#x27; <a href="https:&#x2F;&#x2F;www.tinaja.com&#x2F;" rel="nofollow">https:&#x2F;&#x2F;www.tinaja.com&#x2F;</a>
Animatsalmost 3 years ago
&quot;The 200 Class Seaplane Tender&quot;, by &quot;Shaw&quot; is a famous example of writing clarity. T. E. Lawrence (&quot;Lawrence of Arabia&quot;) wrote this, while he was involved in testing a speedboat.<p>I can&#x27;t find the text on line any more. Just ads for it as a collectable.
Beltalowdaalmost 3 years ago
I enjoy Ted Unangst&#x27;s writings because they&#x27;re both informative as well as written in a kind of fluent non-forced &quot;fun&quot; style that I enjoy: <a href="https:&#x2F;&#x2F;flak.tedunangst.com&#x2F;" rel="nofollow">https:&#x2F;&#x2F;flak.tedunangst.com&#x2F;</a>
N1H1Lalmost 3 years ago
It&#x27;s not writing per se, but from a presentation of complex, technical material standpoint - I find 3blue1brown unparalleled<p><a href="https:&#x2F;&#x2F;www.youtube.com&#x2F;c&#x2F;3blue1brown" rel="nofollow">https:&#x2F;&#x2F;www.youtube.com&#x2F;c&#x2F;3blue1brown</a>
mfrwalmost 3 years ago
<a href="https:&#x2F;&#x2F;planetscale.com&#x2F;blog&#x2F;generics-can-make-your-go-code-slower" rel="nofollow">https:&#x2F;&#x2F;planetscale.com&#x2F;blog&#x2F;generics-can-make-your-go-code-...</a><p>The blog post on go generics seemed to be a very well written piece.
ChrisMarshallNYalmost 3 years ago
I&#x27;ve always liked Steve McConnell&#x27;s writing, and Joel Spolsky is excellent.
13415almost 3 years ago
This may not be what your looking for but I really like CASIO product manuals. They are concise, yet provide all the information needed. You can download them for free for any of their products from their website.
enasterosophesalmost 3 years ago
Douglas Hofstadter&#x27;s work provides several examples.<p>* Gödel, Escher, Bach: an Eternal Golden Braid (GEB)<p>* Metamagical Themas<p>* I Am A Strange Loop (IAASL)<p>GEB and IAASL are thematically similar, and both are worth a read if you&#x27;re interested in both Gödel&#x27;s theorems (plus related work eg Church-Turing) and Hofstadter&#x27;s philosophy of mind. GEB is a lot more creative and fun; IAASL does a better job of communicating the key technical ideas like incompleteness.<p>Metamagical Themas is a collection of shorter work, generally technical and fun.<p>Although Hofstadter was the first to come to my mind, these other authors&#x2F;works also provide fun and&#x2F;or excellent examples of technical writing:<p>* Neal Stephenson&#x27;s &quot;In the Beginning was the Command Line&quot;<p>* Velleman&#x27;s &quot;How To Prove It&quot; and &quot;Philosophies of Mathematics&quot;<p>* Mittelbach &amp; Goosens &quot;The LaTeX Companion&quot;<p>* Waldrop&#x27;s &quot;The Dream Machine&quot;<p>* Nielsen &amp; Chuang&#x27;s &quot;Quantum Computation &amp; Quantum Information&quot;<p>* Lakatos&#x27;s &quot;Proof &amp; Refutations&quot;<p>* Chambers &quot;What is this thing called science?&quot;<p>* Doxiadis &amp; Papadimitriou&#x27;s &quot;Logicomix&quot;.
532nmalmost 3 years ago
For electronics, my vote goes to various spectacular application notes from the electronics industry that have stood the test of time. In comparison to the usual literature (textbooks, papers, etc.), these are often laser-focused on helping the user, often at a holistic level, including practical issues. This is a rare case where the incentives of the readers and producers are well aligned: In order to sell their products, manufacturers need to teach their prospective customers enough to use their products adequately. If a product is good, but a customer makes (potentially silly) mistakes in using it, both the customer and the manufacturer lose -- which is exactly what application notes are intended to counteract.<p># Example 1: Old HP application notes<p>Quote: &quot;In a real sense, Hewlett-Packard sold MEASUREMENTS as well as products. According to one marketing professional, when you go to a hardware store to buy a 5mm drill bit, what you really want is a 5mm hole. So, likewise, as HP developed their massive line of innovative measurement instruments, the customers often had to be educated in the newer processes of the new measurement techniques, permitted by the newest product.&quot;<p>I&#x27;m too young to have experienced the heyday of HP as a test &amp; measurement company, but they produced spectacularly good material. Many of their application notes introducing the fundamentals of a field such as spectrum analysis, signal analysis, modal testing etc. remain excellent introductions even today, despite being decades old and thus predating my birth. I&#x27;ve thoroughly enjoyed the following ones (amongst others):<p>[1] AN243 The Fundamentals of Signal Analysis<p>[2] AN243-3 The Fundamentals of Modal Testing<p>[3] AN150 Spectrum Analysis Basics (updated version)<p># Example 2: LTC application notes, especially by Jim Williams<p>A big chunk of my electronics knowledge comes from data sheets and application notes. The application notes by Jim Williams (RIP) stand out to me. Jim obviously was very gifted, but always sides with the (probably much less skilled) reader, making complicated material accessible. He always retains a holistic picture, and also addresses many practical aspects one can easily stumble upon. He does it all with a minimum of math, a maximum of intuition, and a great sense of humour.<p>While there are many dozens of application notes by him, I particularly like the following one:<p>[4] AN47: High Speed Amplifier Techniques<p>Links:<p>[1] <a href="https:&#x2F;&#x2F;www.hpmemoryproject.org&#x2F;an&#x2F;pdf&#x2F;an_243.pdf" rel="nofollow">https:&#x2F;&#x2F;www.hpmemoryproject.org&#x2F;an&#x2F;pdf&#x2F;an_243.pdf</a><p>[2] <a href="https:&#x2F;&#x2F;www.hpmemoryproject.org&#x2F;an&#x2F;pdf&#x2F;an_243-3.pdf" rel="nofollow">https:&#x2F;&#x2F;www.hpmemoryproject.org&#x2F;an&#x2F;pdf&#x2F;an_243-3.pdf</a><p>[3] <a href="https:&#x2F;&#x2F;www.keysight.com&#x2F;us&#x2F;en&#x2F;assets&#x2F;7018-06714&#x2F;application-notes&#x2F;5952-0292.pdf" rel="nofollow">https:&#x2F;&#x2F;www.keysight.com&#x2F;us&#x2F;en&#x2F;assets&#x2F;7018-06714&#x2F;application...</a><p>[4] <a href="https:&#x2F;&#x2F;www.analog.com&#x2F;media&#x2F;en&#x2F;technical-documentation&#x2F;application-notes&#x2F;an47fa.pdf" rel="nofollow">https:&#x2F;&#x2F;www.analog.com&#x2F;media&#x2F;en&#x2F;technical-documentation&#x2F;appl...</a>
sleepydogalmost 3 years ago
This one covering the discovery of the &quot;dirty pipe&quot; vulnerability: <a href="https:&#x2F;&#x2F;dirtypipe.cm4all.com&#x2F;" rel="nofollow">https:&#x2F;&#x2F;dirtypipe.cm4all.com&#x2F;</a>
sangpalalmost 3 years ago
I enjoy Unity documentation <a href="https:&#x2F;&#x2F;docs.unity.com" rel="nofollow">https:&#x2F;&#x2F;docs.unity.com</a>. It is concise and usually includes helpful diagrams.
评论 #31635545 未加载
Epa095almost 3 years ago
Excotic maybe, but I found adyen&#x27;s documentation quite good <a href="https:&#x2F;&#x2F;docs.adyen.com&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.adyen.com&#x2F;</a>
johnchristopheralmost 3 years ago
I haven&#x27;t yet been disappointed in digital ocean articles.
dieselgatealmost 3 years ago
This is probably considered more “science writing” than technical writing but I’m a fan of Ed Yong’s work, he’s a columnist for The Atlantic I believe
noufalibrahimalmost 3 years ago
One book that I&#x27;ve enjoyed a lot is the Programming Pearls book by Jon Bentley. It&#x27;s informative, concise and surprisingly light.
评论 #31635481 未加载
nicboualmost 3 years ago
The NHS website would fit here. Their content is very easy to read, even though it&#x27;s about various medical topics.
signarualmost 3 years ago
Crafting Interpreters by Bob Nystrom.
Hackbratenalmost 3 years ago
Learning Rust With Entirely Too Many Linked Lists [1].<p>[1]: <a href="https:&#x2F;&#x2F;rust-unofficial.github.io&#x2F;too-many-lists&#x2F;" rel="nofollow">https:&#x2F;&#x2F;rust-unofficial.github.io&#x2F;too-many-lists&#x2F;</a>
tunnuzalmost 3 years ago
The Rust Programming Language (the Rust book).
candymanalmost 3 years ago
Stripe documentation. Joy of cooking.
traklalmost 3 years ago
The Linux programming interface.<p>Emacs and Vim manuals.
oxffalmost 3 years ago
<a href="https:&#x2F;&#x2F;doc.rust-lang.org&#x2F;std&#x2F;" rel="nofollow">https:&#x2F;&#x2F;doc.rust-lang.org&#x2F;std&#x2F;</a>
UmbertoNoEcoalmost 3 years ago
One often overlooked aspect of technical writing is the formatting&#x2F;ease of navigation. You could have the most wonderful documentation, very clearly written, but if its navigation is a pain it will degrade the experience and frustrate the user.<p>Just a (rather petty) example, React documentation is often lauded as very good,and I kinda agree.<p>But if you visit from a &quot;low&quot; resolution laptop(1366x768) and click in advanced options to the right on this link:<p><a href="https:&#x2F;&#x2F;reactjs.org&#x2F;docs&#x2F;getting-started.html" rel="nofollow">https:&#x2F;&#x2F;reactjs.org&#x2F;docs&#x2F;getting-started.html</a><p>It turns out you cannot scroll the options easily by using keys or a 2-button mouse because it does not have a scroll bar (why?). You have to use the scroll-wheel(not everybody has it) or drag down the menu in a clunky way, and this is the documentation of a front-end framework.<p>Another pet-peeve of mine it is what I call the &quot;Netflix effect&quot;, the documentation is fine but there is not a clear, straightforward table of contents, and there are lot of internal links in the documentation so you jump from one place to the other but you are not really sure what order you are following or how much ahead or behind you are jumping from your current section. Microsoft .NET documentation is like that.<p>On the other hand, this is a very good example(except by the annoying Discuss thing)<p><a href="https:&#x2F;&#x2F;javascript.info&#x2F;" rel="nofollow">https:&#x2F;&#x2F;javascript.info&#x2F;</a><p>Everything is laid out in a very straightforward way, at any moment you have a very clear mental model of where you are in the document.<p>Postgres, Rails and Django are a little less clear in that sense but still extremely well organized.
throwaway787544almost 3 years ago
<i>La Technique</i>, Jacques Pepin<p><i>Mastering The Art Of French Cooking</i>, Julia Child<p>These books are a combination of background information, recipe, and step by step instruction. So these are more a reference of how to write an implementation guide or Runbook, rather than how to describe an API or present architectural documents.<p>I also really liked <i>Mastering Algorithms With Perl</i>, and any of the For Dummies books on technical subjects.
评论 #31634111 未加载