Skip to main content

Some writing tips

Having delivered the thesis, I've figured out how I'm going to use this blog.

I'm going to continue posting here, writing about web content management, but also about software development in general and other stuff. But the first thing I want to note down are my thoughts on how it was to write the thesis, sharing some writing tips with you.

Writing English

My first advice is: Don't. Unless its your native language, of course. I have had the pleasure of a bi-lingual upbringing, and seeing the English of many other Norwegians, I'm sorry to that generally, Norwegians write lousy English. Its not that we make grammatical or syntactical errors, but the feeling of the sentence is just.. wrong. And don't be fooled: Word or any other another spell-checker is not good enough. I've gone over another thesis which was already "fixed" by Word, and I still managed to empty a red-ink pen in the process.

Another point is that you don't *think* in English. You keep falling back into articulating difficult sentences in your native language, and then you have to translate it. This breaks down productivity, and you also get those Norwegian-English sentences.

If you still have to write English, make sure you know a native speaker who will go over the thesis for you and point out any mistakes and sentences you should reformulate. Train. Write English, and read English books aloud.

Writing flow

Write down what you think. Use notebooks, and get things down. You can always remove things later. Or don't delete things, just move them over to a "snippets" document, saving your thoughts in case you want to include them later (you could always blog about them).

Don't read your thesis too many times. You get tired of it. Write things once, and move on to the next section. Write through what you wrote a month ago. This will give you a fresh view of the content and allow you to

Turn off the spell-checker when you are writing. Those red-lines are also disrupting your writing flow.

Sentence rythm

Bad sentence structures easily bore the reader. Think short-medium-long-medium-short and so on.

Don't use too many "helping" verbs. The subject verbs the object. To will, to be, to have, are helping verbs you can put around the verb, but avoid this. Put the power of the senctence in the verb. Can't think of any good examples right now, but I might get back to that. Also, reduce the amount of adjectives, and put the meaning of them in the verb if this is possible.

Structure and Disposition

Write a disposition. You'll change it later, removing or adding chapters as you see how things are coming along, but a good disposition is the skeleton of your thesis. Write through it many times, each time adding a little more flesh to the bone (ugh, nice picture).

Document-driven development

Plan, and keep track of your changes. I kept a Todo-list. When I completed an item on the list, I moved it to the changelog . Each time I thought of something I should write about, I added it to the Todo-list. I also made checklist, where I added things each time I though "Oh. I'll have to see if that thing is done through the whole document". It was something like this

  • Use of modification/extensibility/extendability/customization or variations of these
  • Use of company/organisation/corporation
  • Use of "you", "I", "we" etc.
  • Upper Cases in Headings
  • Who am I? Programmer/developer/technician/researcher/author , we, I, our, us, me,
  • Who is the user? user/author/content manager/customer/visitor
  • A/applet, J/java
  • Check that all h3 are default formatting (some small ones)
  • Remove apostrophes' (Don't use apostrophes in formal documents.)

Red flags

Stay clear of these, or reformulate them:
  • very
  • little
  • think
  • I thought
  • easy
  • hard
  • seem

The reader

Learn the mind of the reader. I read this book which had some good points on how your thesis is read. For example, the reader wants to see a crystallized research question.

Any how, that's all I've got time for now. I've got some other ideas as well, but I'll have to add them later.


Popular posts from this blog

Managing dot-files with vcsh and myrepos

Say I want to get my dot-files out on a new computer. Here's what I do: # install vcsh & myrepos via apt/brew/etc vcsh clone mr mr update Done! All dot-files are ready to use and in place. No deploy command, no linking up symlinks to the files . No checking/out in my entire home directory as a Git repository. Yet, all my dot-files are neatly kept in fine-grained repositories, and any changes I make are immediately ready to be committed: config-atom.git     -> ~/.atom/* config-mr.git     -> ~/.mrconfig     -> ~/.config/mr/* config-tmuxinator.git       -> ~/.tmuxinator/* config-vim.git     -> ~/.vimrc     -> ~/.vim/* config-bin.git        -> ~/bin/* config-git.git               -> ~/.gitconfig config-tmux.git       -> ~/.tmux.conf     config-zsh.git     -> ~/.zshrc How can this be? The key here is to use vcsh to keep track of your dot-files, and its partner myrepos/mr for o

Open source CMS evaluations

I have now seen three more or less serious open source CMS reviews. First guy to hit the field was Matt Raible ( 1 2 3 4 ), ending up with Drupal , Joomla , Magnolia , OpenCms and MeshCMS being runner-ups. Then there is OpenAdvantage that tries out a handful ( Drupal , Exponent CMS , Lenya , Mambo , and Silva ), including Plone which they use for their own site (funny/annoying that the entire site has no RSS-feeds, nor is it possible to comment on the articles), following Matt's approach by exluding many CMS that seem not to fit the criteria. It is somewhat strange that OpenAdvantage cuts away Magnolia because it "Requires J2EE server; difficult to install and configure; more of a framework than CMS", and proceed to include Apache Lenya in the full evaluation. Magnolia does not require a J2EE server. It runs on Tomcat just like Lenya does (maybe it's an idea to bundle Magnolia with Jetty to make it seem more lightweight). I'm still sure that OpenAdvant

The End of GitMinutes (my podcast)

I'm just about ship GitMinutes episode 46, which is going to be the final episode. I'll just paste the outro script here, as it sums up the sentimental thoughts pretty well: I’m happy to have finally finished [publishing the last episodes from Git-Merge 2017], just in time before Git-Merge 2018 takes place in March. I won’t be going there myself, so I’m counting on someone else to pick up the mic there. It’s sad to be shipping this one as it is probably the last GitMinutes episode ever. To go a bit down memory lane, 6 years ago, my daughter was born, and as I used a little of that paternity leave to set up my podcasting infrastructure and produce the first few episodes. Initially it was just going to be 10 episodes and call the experiment finished. Instead, I got to 46 episodes, the last dozen or so lazily tailing the last few Git-Merge conferences. To every one of my guests, thank you so much again for coming on to share your passion in this little niche of computer s

Joining eyeo: A Year in Review

It's been well over a year since I  joined eyeo . And 'tis the season for yearly reviews, so... It's been pretty wild. So many times I thought "this stuff really deserves a bloggin", but then it was too inviting to grab onto the next thing and get that rolling. Instead of taking a deep dive into some topic already, I want to scan through that year in review and think for myself, what were the big things, the important things, the things I achieved, and the things I learned. And then later on, if I ever get around to it, grab one of these topics and elaborate in a dedicated blog-post. Like a bucket-list of the blog posts that I should have written. Here goes: How given no other structures, silos will grow by themselves This was my initial shock after joining the company. Only a few years after taking off as a startup, the hedges began growing, seemingly almost by themselves, and against the will of the founders. I've worked in silos, and in companies wit

Using Voice-Chat for Gamers in Distributed Teams

This is a post going into the usefulness of live voice-chat tools in distributed teams. If you've ever seen the Leeeeeroooooyy Jeeeenkiiins video of World of Warcraft fame, you've heard this kind of tool in action. It's how the participants in the video are speaking with each other - this is not a feature built into the World of Warcraft game - it's a separate team-oriented VoIP software, and it's all about letting gamers communicate orally while gaming.  Since these tools are for gamers, they have to be fast (low latency) light (as not to steal CPU-cycles from heavy games graphics)  moderate in bandwidth usage (as not to affect the game server connection) There are several options around: TeamSpeak , Ventrilo , more recently the massively grown Discord , and finally Mumble , which is the open-source alternative of the gang. A few years ago, when I joined eyeo (a distributed company), several of the operations team were avid gamers, and had a TeamSp