Skip to main content

How To Give Twisted a Friendly Zero-Step: Part 1

Zero-Step: n. The first impression and actions of a user's exposure to a new tool, before actual research and use of the details.

I'm not as involved with or using Twisted as much I'd like, but I still pay attention and I care about the project. I understand its strengths and its weaknesses and I want to see it used in more cases where it is the best tool for the job. There is a obvious and recently publicized problem with Twisted and the Zero-Step.

Why do people go to for the first time?

Usually, it probably isn't to read the documentation or start investigating open bug reports. First time visitors are looking to solve a problem and the first thing that has to be impressed on them is if Twisted actually solves that problem. This is actually a really big problem in this case, because there are so many problems it can solve. How do you present that image without boring lists of functionality and supported protocols?

The most obvious use-case for Twisted is probably for HTTP setups, while another important angle is probably people looking to test it out with something simple and pointless like an IRC bot. While an IRC bot is boring to a lot of us already familiar with the details, it is a very common introduction people make for network programming.

What kind of timeout can we expect on their willingness to read before getting the gist of it?

Not much, probably. Certainly, it takes more upfront investment in personal time and energy than a lot of people care to make. It would have to be obvious and prominent at the front page how to get a quick introduction that gives you an idea if Twisted is what you're looking for. The most obvious section you'll see now is What is Twisted? with one link in bold that will stand out to a new visitor, sending them to the Twisted Core Documentation. This is a really boring looking page, with no styling, lots of parts with names people won't understand, and an 11-part finger tutorial. This is not an approachable presentation.

The whole section needs replaced with something more eye catching and it needs to lead to a new section of the site that exists just to impress those new eyes. "If you want to get started with Twisted, the first thing you should do is read the Twisted Core Documentation" is too much to ask new comers who have no idea if this is what they're looking for and often don't have time to read that much documentation to make the call, because they've already got a problem with a deadline or simply have a limited amount of free time to pursue the interest on their own. I think there can be a sentiment to just let these facts weed out the less motivated, but it serves to cut out too many who would do the project some good.

How can you get the greatest number of readers to continue interest in Twisted with only one page view to convince them?

If you can fit it in without scrolling, then even better. Being lax enough to allow some scrolling to grok the whole introduction, can you get people intrigued enough to sit through more complete readings of the docs, put up with difficulties getting started and adjusting their way of thinking, and dealing with a relatively steep learning curve?

In Part 2, I'll continue my previous post about Django influencing the presentation of Twisted. Hopefully we can come up with some ideas to make the approach to Twisted less frightening for new users.


glyph said…
I'm glad you're looking at this, and I completely agree that it's a problem, but the real problem has not been a lack of ideas - it's been a lack of implementation muscle. For example, you complain that the Twisted Core Documentation is a boring, unstyled mess: are you aware of the Sphinx migration project? Have you reviewed or authored any of the lore-fixup branches?

I have several Twisted frontpage prototypes, from the last several years (!), lying around which attempted to address this problem in various ways, but which all got unwieldy really fast in attempting to explain all of what Twisted is capable of. What we really need are individual "landing pages" for different classes of user; things which they will hopefully find rather than the front page of But setting up each of those sites, and writing all the content, is a big project, and somebody needs to sit down and do it. You could easily give it a try by sprucing up the project pages on the wiki, though.

Popular posts from this blog

The Insidiousness of The Slow Solution

In software development, slow solutions can be worse than no progress at all. I'll even say its usually worse and if you find yourself making slow progress on a problem, consider stopping while you're a head.

Its easy to see why fast progress is better: either you solve the problem or you prove a proposed solution wrong and find a better one. Even a total standstill in pushing forward on a task or a bug or a request can force you to seek out new information or a second opinion.

Slow solutions, on the other hand, is kind of sneaky. Its insidious. Slow solution is related the Sunk Cost Fallacy, but maybe worse. Slow solutions have you constantly dripping more of your time, energy, and hope into a path that's still unproven, constantly digging a hole. Slow solutions are deceptive, because they still do offer real progress. It is hard to justify abandoning it or trying another route, because it is "working", technically.

We tend to romanticize the late night hacking…

Finding "One Game A Month"

I was really excited about the One Game A Month challenge as soon as I heard about it.
For about two years I've struggled in fits and starts to make my way into game development. This hasn't been productive in any of the ways I hoped when I started. Its really difficult to be fairly experienced as a developer, which I believe I am in my day job as a web developer, while struggling really hard at an area in which your experience just doesn't exist.
Its like being a pilot who doesn't know how to drive.

But this challenge provided a new breath to this little hobby of mine. It gave me a scaffolding to experiment, to learn, to reflect on finished projects. I had spent far too much time on game projects that stretched on far past their exciting phases, bogged down by bad decisions and regret.
And it has worked.
I have a lot to learn. I have a lot of experience to gain through trial and error and mistake and discovery. I have a lot of fun to be had making more small games t…

On Pruning Your Passions

We live in a hobby-rich world. There is no shortage of pastimes to grow a passion for. There is a shortage of one thing: time to indulge those passions. If you're someone who pours your heart into that one thing that makes your life worthwhile, that's a great deal. But, what if you've got no shortage of interests that draw your attention and you realize you will never have the time for all of them?

If I look at all the things I'd love to do with my life as a rose bush I'm tending, I realize that careful pruning is essential for the best outcome. This is a hard lesson to learn, because it can mean cutting beautiful flowers and watching the petals fall to the ground to wither. It has to be done.

I have a full time job that takes a lot of my mental energy. I have a wife and a son and family time is very important in my house. I try to read more, and I want to keep up with new developments in my career, and I'm trying to make time for simple, intentional relaxing t…