Search This Blog

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

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

Labels

Popular posts from this blog

I was recently working with protecting some sensitive data in a typical Java application with a database underneath. We convert the data on its way out of the application using Spring Security Crypto Utilities. It "was decided" that we'd be doing AES with a key-length of 256, and this just happens to be the kind of encryption Spring crypto does out of the box. Sweet!

The big aber is that whatever JRE is running the application has to be patched with Oracle's JCE in order to do 256 bits. It's a fascinating story, the short version being that U.S. companies are restricted from exporting various encryption algorithms to certain countries, and some countries are restricted from importing them.

Once I had patched my JRE with the JCE, I found it fascinating how straight forward it was to encrypt and decrypt using the Spring Encryptors. So just for fun at the weekend, I threw together a little desktop app that will encrypt and decrypt stuff for the given password and sa…

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 operating on many repositories at the same time.

For those who are a bit unaware of what the Git situation on Windows looks like these days, I've dotted down these notes:
Some explanation on these:

msysGit has long been The Way to use Git on Windows. It's basically a port of Git itself, so it's a command-line tool.GitExtensions (includes Visual Studio integration), TortoiseGit, Git Shell, posh-git and most other tools are powered by msysGit.libgit2 is a native library for doing Git stuff. It is developed completely separate from Git itself. The above tools could (and should) probably use libgit2 instead of hooking onto and around msysGit.Github…

Disclaimer: I do not recommend using earphones while on your bike, but there are times or roads where I think it's OK. Pull out your earphones when nearing potentially dangerous situations (like intersections). At least pause the audio.
These tips also apply to anyone unable to look at and touch their device, leaving voice commands their only option (useful for visually impaired people, people wearing thick gloves, etc).
First of all, you need an Android with a fairly new version of Google Now installed, like Lollipop. You'll need a headset with a microphone button. I’ve got an iphone headset that works great with my old Moto G, excluding the volume control.
You need to make sure that a connected headset can bypass the device’s lock mechanism. It’s in:
Settings -> Language & input -> Google voice typing -> Hands-free
Your audio playback software has to work with the Google Now commands. I’ve tried Google Music and BeyondPod successfully.
So, off we go! You’…