Home » Is Markdown Friendly Enough for Non-Technical Users?

Is Markdown Friendly Enough for Non-Technical Users?

Solutons:


I know I’m coming to this thread rather late, but I actually have run usability tests comparing a WYSIWYG editor (iWeb) to a non-WYSIWYG editor based mostly on markdown.

Here’s what I’ve found that users struggle with when using markdown:

  • Tags that require character-level precision. For example, a user’s inclination is to put a space between the square brackets and parentheses when making a link–but that doesn’t work. Likewise, lists only work when there is a space after the asterisk or dash.
  • They get paragraphs fine, but users are often inclined to use a single linebreak (when formatting an address, for example) and these are ignored if you don’t add two spaces to the line before. Not intuitive, and those two spaces are invisible.
  • More complicated tags, like for links and images, slow them down more than simple ones (like for strong and em)–but they can eventually get it if there’s a helpful guide.
  • Users are often not confident that X will work or unsure of exactly what it will do.
  • Users don’t always understand paths, directories, files, file extensions, URLs, etc. This makes making links and images difficult.

Here’s what I’ve found helps:

  • Provide a clear and explicit guide to markdown
  • Tell them they are using a markup language
  • Style the text field so that it doesn’t look like a WYSIWYG field (eg: use a fixed width font)
  • Consider syntax highlighting
  • Be clear about any situations that are counter-intuitive or require attention to detail
  • Provide a preview option (it doesn’t have to be real-time, but it must be easy and unobtrusive)
  • Depending on the application, consider tweaking it slightly (like allowing a URL like www.example.com and adding http:// automatically)
  • At the very least, provide buttons for the more complicated tags like images and links. It’s trivially easy for the programmer to make a little dialog box that asks for the URL and the link text and inserts the code automatically. Consider making the language easy to understand. Instead of asking for the URL, ask “What web address would you like to link to?” Take a look at how Javascript WYSIWYG editors use non-technical language here.
  • Give them an idea of why this is important. Explain that semantics and presentation are separated in web design, and that computers generate bad code–so they are helping the program understand the semantic structure of the document.

I was surprised to find that people were mostly getting it, with no guidance from me and just a short guide to the markup language. In a study with 22 total users, the average satisfaction was slightly lower for iWeb than with my application.

If you’re talking about an entire WYSIWYG web design program, not just a little widget for text entry–they’re not as usable as you’d think. There are so many little details, and so much can go wrong, even when the interaction is supposed to be intuitive.

Caveat: my participants were all college students of varying technical skill levels, but they were all more tech-savvy than the average user. They were also being compensated for their time, which may account for their interest in the task.

Edit Almost all of the above issues have been improved by the stuff in the second list. The only one I’m still really struggling with is the single linebreak problem.

Unfortunately not.

When you say non-technical: there’s a huge difference between non-programmer and 90% of the non-technical users out there.

A surprising number of users (I think it’s around a third of everyone on the web) can’t scan text – they will use their finger on a page to read and will lose their place if forced to scroll.

These users will struggle with even simple WYSIWYG, never mind any sort of markup.

A good article on the issue is: http://www.useit.com/alertbox/20050314.html

I’d recommend taking a look at that site for most usability research like this.

If a user is struggling to understand the I-bar and caret they’re never going to understand any sort of meta-information.

On a largeish project, I thought textile would be simple enough for non technical users. It turns out I was wrong, and my clients just couldn’t cope with it at all. The problem eventually became so severe that they replaced my whole system. The system I spent 8 months building.

Live and learn. To be honest, I don’t think Markdown is easy enough for TECHNICAL users. The problem is it gets applied to content entry forms without informing the user that it’s going to be filtered through markdown. Text gets mangled, and there’s no way to know what happened unless your eyes are sharp enough to notice some tiny note somewhere.

There’s a dozen of these different markupish languages with slightly differing semantics, and each one is a whole new set of things to learn. You come to a comment form, and who the hell knows what’s going to happen? is it textile, markdown, bbcode, how on earth do I make a link? It’s a mess.

Well there you go. Two data points. A client couldn’t cope with it. I can’t cope with it. The only reason I have any idea what’s going on here on stackoverflow is the gui buttons. and the realtime preview.

@tj111 a cheat sheet helps me, but it didn’t seem to help anyone else. I’d even pointed it out numerous times, but it just didn’t seem to take hold. I ended up doing all the textile myself.

Related Solutions

Extract file from docker image?

You can extract files from an image with the following commands: docker create $image # returns container ID docker cp $container_id:$source_path $destination_path docker rm $container_id According to the docker create documentation, this doesn't run the...

Transfer files using scp: permission denied

Your commands are trying to put the new Document to the root (/) of your machine. What you want to do is to transfer them to your home directory (since you have no permissions to write to /). If path to your home is something like /home/erez try the following:...

What’s the purpose of DH Parameters?

What exactly is the purpose of these DH Parameters? These parameters define how OpenSSL performs the Diffie-Hellman (DH) key-exchange. As you stated correctly they include a field prime p and a generator g. The purpose of the availability to customize these...

How to rsync multiple source folders

You can pass multiple source arguments. rsync -a /etc/fstab /home/user/download bkp This creates bkp/fstab and bkp/download, like the separate commands you gave. It may be desirable to preserve the source structure instead. To do this, use / as the source and...

Benefits of Structured Logging vs basic logging

There are two fundamental advances with the structured approach that can't be emulated using text logs without (sometimes extreme levels of) additional effort. Event Types When you write two events with log4net like: log.Debug("Disk quota {0} exceeded by user...

Interfaces vs Types in TypeScript

2019 Update The current answers and the official documentation are outdated. And for those new to TypeScript, the terminology used isn't clear without examples. Below is a list of up-to-date differences. 1. Objects / Functions Both can be used to describe the...

Get total as you type with added column (append) using jQuery

One issue if that the newly-added column id's are missing the id number. If you look at the id, it only shows "price-", when it should probably be "price-2-1", since the original ones are "price-1", and the original ones should probably be something like...

Determining if a file is a hard link or symbolic link?

Jim's answer explains how to test for a symlink: by using test's -L test. But testing for a "hard link" is, well, strictly speaking not what you want. Hard links work because of how Unix handles files: each file is represented by a single inode. Then a single...

How to restrict a Google search to results of a specific language?

You can do that using the advanced search options: http://www.googleguide.com/sharpening_queries.html I also found this, which might work for you: http://www.searchenginejournal.com/how-to-see-google-search-results-for-other-locations/25203/ Just wanted to add...

Random map generation

Among the many other related questions on the site, there's an often linked article for map generation: Polygonal Map Generation for Games you can glean some good strategies from that article, but it can't really be used as is. While not a tutorial, there's an...

How to prettyprint a JSON file?

The json module already implements some basic pretty printing in the dump and dumps functions, with the indent parameter that specifies how many spaces to indent by: >>> import json >>> >>> your_json = '["foo", {"bar":["baz", null,...

How can I avoid the battery charging when connected via USB?

I have an Android 4.0.3 phone without root access so can't test any of this but let me point you to /sys/class/power_supply/battery/ which gives some info/control over charging issues. In particular there is charging_enabled which gives the current state (0 not...

How to transform given dataset in python? [closed]

From your expected result, it appears that each "group" is based on contiguous id values. For this, you can use the compare-cumsum-groupby pattern, and then use agg to get the min and max values. # Sample data. df = pd.DataFrame( {'id': [1, 2, 2, 2, 2, 2, 1, 1,...

Output of the following C++ Program [closed]

It works exactly like this non-recursive translation: int func_0() { return 2; } int func_1() { return 3; } int func_2() { return func_1() + func_0(); } // Returns 3 + 2 = 5 int func_3() { return func_2() + func_1(); } // Returns 5 + 3 = 8 int func_4() { return...

Making a circle out of . (periods) [closed]

Here's the maths and even an example program in C: http://pixwiki.bafsoft.com/mags/5/articles/circle/sincos.htm (link no longer exists). And position: absolute, left and top will let you draw: http://www.w3.org/TR/CSS2/visuren.html#choose-position Any further...

Should I use a code converter (Python to C++)?

Generally it's an awful way to write code, and does not guarantee that it will be any faster. Things which are simple and fast in one language can be complex and slow in another. You're better off either learning how to write fast Python code or learning C++...

tkinter: cannot concatenate ‘str’ and ‘float’ objects

This one line is more than enough to cause the problem: text="რეგულარი >> "+2.23+ 'GEL' 2.23 is a floating-point value; 'GEL' is a string. What does it mean to add an arithmetic value and a string of letters? If you want the string label 'რეგულარი...