background preloader

Documentation

Facebook Twitter

Writing great documentation. Now that I’ve discussed what kinds of technical documentation to write, I can move on to the question of how to actually develop a writing style that produces great technical documentation. Learn to write Unfortunately, there aren’t any shortcuts here. The best way to learn how to write great documentation is to first learn how to write (anything). There are some important differences between technical documentation and your average prose, but a solid foundation of good written communication skills is an irreplaceable prerequisite.

So how do you learn to write (anything) well? There’s only one answer: you’ll learn to write well if you write. Writing English isn’t any different than writing code: the more you do it, the better you get. That’s how those of us with humanities degrees (I’ve got a degree in American Literature, also known as a “B.A. in B.S.”) become good writers: our degrees force us to write to the point that it comes easily.

Watch for how authors accomplish “tone”. Grammar. Kademlia: A Design Specification. Introduction Kademlia is a communications protocol for peer-to-peer networks. It is one of many versions of a DHT, a Distributed Hash Table. Network Characterization A Kademlia network is characterized by three constants, which we call alpha, B, and k. The first and last are standard terms. The second is introduced because some Kademlia implementations use a different key length. alpha is a small number representing the degree of parallelism in network calls, usually 3 B is the size in bits of the keys used to identify nodes and store and retrieve data; in basic Kademlia this is 160, the length of an SHA1 digest (hash) k is the maximum number of contacts stored in a bucket; this is normally 20 It is also convenient to introduce several other constants not found in the original Kademlia papers.

Note The fact that tRepublish and tExpire are equal introduces a race condition. The Node A node needing a value searches for it at the nodes it considers closest to the key. NodeID Keys The K-Bucket Join. L1sp.org. API Specifications. Oracle Technology Network > Java Software Downloads View All Downloads Top Downloads New Downloads What's New Java in the Cloud: Rapidly develop and deploy Java business applications in the cloud.

Essential Links Developer Spotlight Java EE—the Most Lightweight Enterprise Framework? Blogs Technologies Contact Us About Oracle Cloud Events Top Actions News Key Topics Oracle Integrated Cloud Applications & Platform Services. 10 Reasons Why Documentation is a Startup Secret Sauce.