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 twistedmatrix.com 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.

Comments

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 twistedmatrix.com. 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

Interrupting Coders Isn’t So Bad

Here’s a hot take: disrupting coders isn’t all that bad.

Some disruptions are certainly bad but they usually aren’t. The coder community has overblown the impact. A disruption can be a good thing. How harmful disruption might be a symptom of other problems.

There are different kinds of disruptions. They are caused by other coders on your team, managers and other non-coders, or meetings throughout the day.

The easiest example to debunk is a question from a fellow developer. Imagine someone walks over to your desk or they ping you on Slack, because they have “one quick question.” Do you get annoyed at the interruption when you were in the middle of something important? You help out your teammate quickly and get back to work, trying to pick up where you left off. That’s a kind of interruption we complain about frequently, but I’m not convinced this is all that bad.

You are being disrupted but your team, of which you are only one member of the whole unit, is working smoothly. You unstuck …

Announcing Feet, a Python Runner

I've been working on a problem that's bugged me for about as long as I've used Python and I want to announce my stab at a solution, finally!

I've been working on the problem of "How do i get this little thing I made to my friend so they can try it out?" Python is great. Python is especially a great language to get started in, when you
don't know a lot about software development, and probably don't even know a lot about computers in general.

Yes, Python has a lot of options for tackling some of these distribution problems for games and apps. Py2EXE was an early option, PyInstaller is very popular now, and PyOxide is an interesting recent entry. These can be great options, but they didn't fit the kind of use case and experience that made sense to me. I'd never really been about to put my finger on it, until earlier this year:

Python needs LÖVE.

LÖVE, also known as "Love 2D", is a game engine that makes it super easy to build small Lua…

CARDIAC: The Cardboard Computer

I am just so excited about this.


CARDIAC. The Cardboard Computer. How cool is that? This piece of history is amazing and better than that: it is extremely accessible. This fantastic design was built in 1969 by David Hagelbarger at Bell Labs to explain what computers were to those who would otherwise have no exposure to them. Miraculously, the CARDIAC (CARDboard Interactive Aid to Computation) was able to actually function as a slow and rudimentary computer. 
One of the most fascinating aspects of this gem is that at the time of its publication the scope it was able to demonstrate was actually useful in explaining what a computer was. Could you imagine trying to explain computers today with anything close to the CARDIAC?

It had 100 memory locations and only ten instructions. The memory held signed 3-digit numbers (-999 through 999) and instructions could be encoded such that the first digit was the instruction and the second two digits were the address of memory to operate on. The only re…