Documentation + Wordpress

DH 102: Data in the Humanities

Prof. Mackenzie Brooks

October 6, 2016

Documentation sounds boring.

Sometimes it is boring.

But it's really, really important.

It helps you:

• Keep track of what worked and what didn't
• Remember what you did in the past
• Figure out future work
• Clarify your process
• Develop your writing
• Be consistent

It helps other people:

• Understand what you did and how you did it
• Learn from your example
• Replicate/reproduce your project
• It helps other people. Full stop.

How?

• Keep it simple
• Use a text file
• Conventionally, named README.txt
• Markdown!
• Include screenshots when appropriate.

A beginner’s guide to writing documentation

What to Write - Jacob Kaplan Moss

Wordpress!

1. Choose your own theme!
2. Arrange content by unit
3. Have a place for your blog posts
4. See assignment description for what should be posted to Wordpress.

Speaking of documentation:

codex.wordpress.org