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

  • Acronyms (WCM, WCMS, ECM, XML, JSP, WS, JSR, JCP, JCR, WYSIWYG)
  • 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.

Comments

Popular posts from this blog

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

Considerations for JavaScript in Modern (2013) Java/Maven Projects

Disclaimer: I'm a Java developer, not a JavaScript developer. This is just what I've picked up the last years plus a little research the last days. It's just a snapshot of my current knowledge and opinions on the day of writing, apt to change over the next weeks/months. We've gone all modern in our web applications, doing MVC on the client side with AngularJS or Ember , building single-page webapps with REST backends. But how are we managing the growing amount of JavaScript in our application? Yeoman 's logo (not necessarily the conclusion of this blog post) You ain't in Kansas anymore So far we've just been doing half-random stuff. We download some version of a library and throw it into our src/main/webapp/js/lib , or we use it from a CDN , which may be down or unreachable when we want to use the application.. Some times the JS is minified, other times it's not. Some times we name the file with version number, other times without. Some

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 https://github.com/tfnico/config-mr.git 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

What I've Learned After a Month of Podcasting

So, it's been about a month since I launched   GitMinutes , and wow, it's been a fun ride. I have gotten a lot of feedback, and a lot more downloads/listeners than I had expected! Judging the numbers is hard, but a generous estimate is that somewhere around 2000-3000 have listened to the podcast, and about 500-1000 regularly download. Considering that only a percentage of my target audience actively listen to podcasts, these are some pretty good numbers. I've heard that 10% of the general population in the western world regularly listen to podcasts (probably a bit higher percentage among Git users), so I like to think I've reached a big chunk of the Git pros out there. GitMinutes has gathered 110 followers on Twitter, and 63, erm.. circlers on Google+, and it has received 117 +'es! And it's been flattr'ed twice :) Here are some of the things I learned during this last month: Conceptually.. Starting my own sandbox podcast for trying out everythin

Git Stash Blooper (Could not restore untracked files from stash)

The other day I accidentally did a git stash -a , which means it stashes *everything*, including ignored output files (target, build, classes, etc). Ooooops.. What I meant to do was git stash -u , meaning stash modifications plus untracked new files. Anyhows, I ended up with a big fat stash I couldn't get back out. Each time I tried, I got something like this: .../target/temp/dozer.jar already exists, no checkout .../target/temp/core.jar already exists, no checkout .../target/temp/joda-time.jar already exists, no checkout .../target/foo.war already exists, no checkout Could not restore untracked files from stash No matter how I tried checking out different revisions (like the one where I actually made the stash), or using --force, I got the same error. Now these were one of those "keep cool for a second, there's a git way to fix this"situation. I figured: A stash is basically a commit. If we look at my recent commits using   git log --graph --