NaNoWriMo 2013

This is the first year that I’ve joined National Novel Writers Month (NaNoWriMo). For those who are unfamiliar with NaNoWriMo, it is a challenge for participants to write a 50,000 word novel in only the 30 days of November. I don’t write much fiction, preferrering the structure, regularity, and utter lack-of-frills in technical writing.

Not to say that I haven’t tried “creative writing”. When I was still in school, I would often embark upon a short story, get about two thousands words into it, then give up rather unceremoniously. I thoroughly enjoyed creating the world, creating characters, but I struggled with finding a sound plot and the dialogue that I attempted was always dire.

I’ve had many friends get to the end of NaNoWriMo and tell me how liberating it was, quieting their inner editor to produce volume over quality. They wrote without regard to how well it would be written and it let them explore their writing in ways they’d never done before. There was also the satisfaction of having completed such a challenge, though silly it could be from an outsider’s perspective. The writers equivalent of running a marathon for no other reason than just to say you’ve done it once. I’d considered it in years past but something always came up – university exams, moving house, getting married – so I never tried. But this year, I had no excuses….

The first week of this year’s NaNoWriMo was exciting. I started out with dialogue and used that to create my characters. I interspersed it with some scene setting and sprinkled in some intruigue, hoping that any of it would lead to a plot. By the end of the first week, I had just over 10,000 words and no fewer than six interesting characters. Unfortunately, the story had gone nowhere.

It’s now Day 16 and I’m approximately 1000 words behind where I ought to be for this time on this day. I fell behind during what is referred to as the “week 2 blues”. I’d experienced something similar before – my company offerered an intensive one month training course (6.5 hours of lecture a day, 5 days a week, 3.5 weeks). The beginning of the second week was painful and all I wanted to do was give it a rest. For this NaNoWriMo, writing was like pulling teeth. I was uninspired and found myself wishing I was reading the Metro on the train instead of standing with my laptop propped up on the bicycle rack. I never stopped writing but I spent so much time staring at the screen that I’d fallen 2500 words behind.

Someone recommended that I introduce a natural disaster to shake the characters out of their lull – another friend recommended a fire. I thought I’d run with it, wrote that a neighbour’s house was set on fire, and let the characters react to that. Somehow, a plot bloomed. I found myself geting angry when the train stopped at my station and I had to shut down the computer to cycle home. I’d had a series of evening after-work outings and really ought to have been sleeping as soon as I got in, but I found myself laying awake in bed, forcing myself not to get out of bed to grab the laptop.

If in doubt, put your characters in a fire. If you really like them, then they’ll easily find a way to escape. If you don’t like them, then maybe their clever escape will redeem them.

15 days down, 15 days to go… [to be continued]

The Techaddicted Guide to Documentation

I’m forever telling my developer friends that “Documentation is not a dirty word!”. But, for most of them, documentation is that thing their managers tell them they need to do, that thing that gets in the way of coding, that thing that takes forever because they don’t know how to do it and the don’t want to do it. These same friends keep asking me “We’re falling behind schedule at work and so my boss wants to hire another developer — I suggested hiring a writer but apparently we don’t have the budget for that! How do I convince management that it’s worthwhile to hire a writer?!” I’ve previously written a blog post about this, but I realise it’s not enough.

So I put together a presentation that addresses two main points:

  1. How to write documentation – Because sometimes documentation is inescapable and it doesn’t need to always be painful.
  2. How to justify hiring a technical writer – Lacking hard statistics, but with a story and diagram.

I presented this at Tech Meetup Edinburgh back in July. You can watch my presentation below (30min, including questions) or you can just flick through the slides yourself (View Slides).

Denise Marshall talks about Documentation from TechMeetup on Vimeo.

NOTE: Most of my images are from XKCD. See http://xkcd.com/license.html for license info.

Words to Avoid

After my presentation, I got a few requests to share my list of Words-to-Avoid

That list can really be broken down into two categories:

  1. Ambiguous words – they have more than one meaning and both meanings are frequently used. But one way of using the word can be easily replaced with another, non-ambiguous word. Sometimes you need to use a word that has multiple meanings, but if you consistently use it to only ever mean one thing, then that goes a long way to helping keep things clear.
  2. Warning words – words that should warn you that your writing is in the wrong tense, wrong tone, or something else un-good.#

Lets start with the ambiguous words….

Ambiguous Words

Once

Once should only ever be used to mean one time. You do something only once. Though once upon a time doesn’t really belong in serious documentation. Most of the time, the word after is a perfect drop-in replacement for the incorrect usage of once.

Hint: If you use once at the start of the sentence, it’s probably incorrect. Sometimes it’ll be in the middle of the sentence. Every time you use the word once, think to yourself if you can replace once with after and keep the meaning of the sentence – if you can, then do it.

Good: Click the button once to save your document.
Bad: Once you’ve clicked the button,  the system restarts.

Replace bad of once with after

Correction: After you’ve clicked the button, the system restarts.

Since

Since is commonly used in conversational English to mean because. For example, “Since I don’t like peppers, I always have to pick them off of the veggie pizza” is fine for explaining that I am picking peppers off my pizza because I don’t like them. But since also serves as a great word for describing “time that has elapsed between this previous event and now” quite succinctly, such as in “I haven’t eaten since breakfast”. Because since can easily be replaced by because in some cases, the because sense of since should be replaced with because to make the usage of since in the temporal as unambiguous as possible.

Good: If you have not restarted your system since installing updates, do so now.
Bad: The updates have not been fully installed since you have not yet restarted your computer.

Replace bad since with because

Correction: The updates have not been fully installed because you have not yet restarted your computer.

May/Might

May and might suffer from the same problem — are you trying to say that it is possible that something has the ability to happen or are you saying that something has permission to do something. It’s like being back in school again and Miss is telling you “Yes, you can go to the toilet but no, you may not”.

Just forget about may and might and your Miss who’s making you hold it until lunchtime. Just use can and could instead. But when would you use which?

  • can for permission
  • could for ability

Good: You can create a new customer account.
Good: The system could crash if you do not create the order using the wizard.
Bad: You may create a new customer account. (Do you mean “You have permission to”? “You have the ability to”? “There is a possibility that you want to”? etc. So many different meanings!)
Bad: The system might crash if you do not create the order using the wizard.

Warning Words

Will

If you’re using the word will, it means you’ve slipped into future tense. Stay in present tense.

Good: The report opens.
Bad: The report will open.

Please

You don’t need to be nice in serious documentation.  Conversational writing can work for you, but be careful of humour in technical documents. Humour is difficult to read and is even more difficult to translate. If you’re including words like please, you may be slipping into other casual language. In technical documents, just stick to the facts.

Please implies that the reader does not need to do what you’re going to ask them to do and that you don’t think they’ll like to do it – you just need to tell them do do it.

Should

Nothing should happen. Either it can happen or it does happen.

Pedal on Parliament 2 Musings

Pedal on Parliament, for those who haven’t heard of it, is a gathering of cyclists before the Scottish Parliament who believe that the Scottish government need to do more to support cyclists and pedestrians in this country. Last year, 3000 riders made it – this year it was 4000 despite the gloomy weather. The message, we hope, was clear: we need more.

My Brompton with Burley Travoy trailer

I took my Brompton, expecting that there might be a few other bikes on the train – but it was surprisingly quiet. I was, though, headed into Edinburgh several hours before the start of the ride.

I dressed my bike with my Burley Travoy, mostly to show it off to folk who may not have realised that not all trailers are designed for long hauls or children. I got a few comments from folk who saw how it could double as a shopping trolly (which is actually how I tend to use it) and thought it was a good design. I’d attached the Brompton’s front bag to the trailer just so that there would be something on the trailer.

I wore my helmet to and from Pedal on Parliament 2, but I took advantage of the opportunity and left it attached to my trailer for the group ride from the Meadows to the Scottish Parliament. It was… unbelievably liberating.
I’ve written a separate post about my bicycle helmet and why I wear it when I cycle in the city. Have a look here: http://www.techaddiction.co.uk/2013/05/bicycle-helmets/

What I saw

The crowd of cyclists at Pedal on Parliament 2

I was absolutely tickled at the sheer number of families that were there with kids. I know it must not have been easy cycling down the Royal Mile with them (cobblestone streets aren’t pleasant at the best of times), the poor dears must have been terribly shaken (literally) by the time they reached the bottom. I don’t have kids but I desperately hope that, by the time I do have them and they’re big enough to ride their own pedal bikes, the roads are friendly enough that I can cycle along with them to school without worrying about their safety.

I was actually surprised by the amount of florescent I’d seen that day. I was expecting less. Really, I was expecting it to look more like the Pedal for Scotland last year where the vast majority of cyclists were just cycling in whatever they thought would be most comfortable for the day (generally shorts and t-shirts), like a miniature  Amsterdam or Copenhagen, if only for a couple roads for a couple hours.

On the day, I ended up wearing my florescent pink cycling jacket, mostly because there were some people I was hoping to meet up with and there aren’t many who wear hot pink on their bikes. I wanted to be found in the crowd.

I usually wear the florescent so that cars will see me when I’m pedalling  down the road. I’d recently read a study done by Direct Line which used eye tracking to find that that one in five cyclists aren’t seen by car drivers [source]. I don’t fancy being one of those unseen cyclists, especially when I’m cycling down the middle of the lane trying to avoid the horrible potholes.

What I hope happens now

Car driving in the cycle lane

As I’m sure you can tell, by now, all I want is a place I can cycle without needing to worry that I’m going to end up under someone’s wheels. The current infrastructure is neglected — the advanced stop boxes are not enforced; cars park in cycle lanes; cycle lanes end just before roads  narrow (where cycle lanes are most important); cars frequently ride in the cycle lanes, endangering cyclists currently using them; etc.

I really hope that our turnout shows those who have control over the planning and budget that we expect more of them.

Bicycle Helmets

I tell people that  the reason that I wear a helmet is because I once came off my bike (after skidding on a patch of sand left over from the winter’s gritting) and ended up against a stone wall. A helmet didn’t save my life, probably didn’t even save me a concussion, but it could have.

The truth is that the older I get, the less I think that my helmet is worthwhile. I keep hoping that, eventually, I’ll be able to cycle without the helmet. It’s really wonderful feeling the breeze through my hair. I forget just how sweaty the helmet makes my forehead. I keep thinking to myself I think I could enjoy cycling  without a helmet. And I don’t think it’s likely that a helmet would help much in the types of accidents I’m likely to have. [cyclehelmets.org]

But I keep reading, in the papers and online, stories like that of Audrey Fyfe who was struck by a car [BBC News]. Some key lines jump out at me that I feel compelled to share:

The cyclist, who was not wearing a helmet at the time…

and

The sheriff said Mrs Fyffe “wasn’t to blame in any way for the accident”, but added: “She was not wearing a safety helmet and that in my view contributed to her death.”

I find it  frustrating that journalists feel the need to mention whether or not the cyclist was wearing a helmet, as if that’s the thing that determines whether whether it’s a tragic accident or an asked-for eventuality. And I wonder if this attitude by the media is a reflection of the attitudes of the public on the whole (like the sheriff who partly blamed Mrs Fyffe for her own death) or if the attitudes of the public are affected by this constant reminder that this cyclist or that cyclist was or was not wearing a helmet.

So every time I read a news article that mentions whether or not the cyclist was wearing a helmet, I am forced to think to myself if I were to get into a collision, completely the fault of another road user, would my family be denied compensation because I wasn’t wearing a helmet?

NHS Hack Scotland

Two weekends ago, I attended NHS Hack Scotland with my husband. Well, he attended the whole weekend and I turned up for the Sunday. I really wish I’d been there for the full weekend!

The weekend event took place at the Edinburgh Tech Cube, an older university building that has been re-imagined as a first class technology startup space. I’d never been in the building before but I’d walked past it dozens upon dozens of times in my years at uni. The space that the NHS Hack Scotland was taking up was only very recently opened and was yet unfinished. Cables hung from the ceiling in a way that I could only describe as “a bit steampunk” but the paint was fresh, there were power sockets everywhere, and the wifi was strong!

When I arrived at the end of the Saturday, I sat quietly in the corner until an organiser (whose name I can’t recall) approached and asked if I’d just arrived. When I said I had and asked how the event was progressing, he waved me over to where my husband was and encouraged me to join the group. I quickly learned that my husband’s group was creating a One Website to Rule Them All for the NHS, pulling in local information about NHS24, GPs and A&Es and such, so that a user could quickly get contact details for the help they need. I must say that I was a bit disheartened to find that such a tool was necessary in the first place, as I had assumed that the NHS24 site was already doing precisely that (See NOTE 1 below).

That evening, I joined everyone in the pub and then on to Illegal Jacks where I  chatted with a couple other attendees at length about Basic English and restricted vocabularies to increase consistency in patient pamphlets (See NOTE 2 below).

Because I was only there for the second day, most of what I learned about the other groups came during the final presentations. I watched many groups describing solutions such as an app to record anxiety levels (to contrast with the current pen-and-paper solution), an app to direct ambulance drivers to the nearest GP, pharmacy, or A&E (since they are already at the house with the patient, it doesn’t strictly send them out of their way to bring a not-too-ill patient to their GP instead of to the A&E), and a game that encourages patients to continue on with a new regimen. All of them were great ideas to solve problems that I didn’t know the NHS even had!

The folks that were there were quite split between developers and NHS staff. It was great having the opportunity to show those who are not particularly technical how problems can be solved relatively quickly and easily with a bit of clever code. I, myself, am not a coder, nor was I NHS, so I provided what services I could — I drew a wee logo and helped facilitate conversation. I would love to attend an event like this again in the near future, especially knowing that it doesn’t matter that I’m not a stellar programmer.

Yes, that is all.

NOTE 1: The poor information architecture of the NHS24 website, in contrast to the webpage that our team put together, made me very interested in learning more about UI design. It’s something I’ve always wanted to get involved in but, without an academic qualification in the subject, few will trust my suggestions. So, driven, I’ve signed up for a Human Computer Interaction course on coursera.org. Wish me luck!

NOTE 2: A future NHS hack project might be creating a text editor for the NHS that restricts the vocabulary to only words that a child about 10 years old could read and understand. If a user of the text editor uses a word that is not in the dictionary, it underlines the word and suggests simple synonyms. Because medicine has a lot of required terminology, a word can be “excused” provided it is defined in a glossary written in simple English at the back. This would ensure that the majority of patients could understand what is written, and it would encourage more consistent writing across practices.

Cyclist Labelling

Anyone who’s spoken to me in the last couple years is probably bored of hearing about my bicycle. I love my bicycle and I love cycling — to the point that I am starting to hate walking and how slow it is. I love the feeling of wind through my hair (well, what wind can make it through the holes in my cycling helmet) and the rush that comes from keeping up with the taxis going down the hill. I also love talking about cycling, about infrastructure improvements, about infrastructure failings, about my experiences cycling…. (ask me sometime, when you’ve got a few hours free)

But when I talk to people about cycling, I have to make it clear that I don’t represent all cyclists. In fact, there’s as many different types of cyclist as there are types of driver or pedestrian. So here’s a couple terms that could be used to describe me:

  • I am a female cyclist. It shouldn’t make a difference but it seemingly does to some. From what I can see on the streets of Edinburgh, there’s one female cyclist for every 3 male cyclists, which agrees with the various websites I’ve read. There are still many of us, but we are a minority.
  • I am a transportation cyclist (a.k.a. utility cyclist). I cycle instead of using a car, every chance I get (though, to be fair, I usually only cycle as far as the nearest train station). I have my Brompton which folds up to go on the train or the bus as necessary, and I have a Burley Travoy for when I have a lot to carry on my bike. I don’t cycle for sport and very rarely do I go for a wander on my bicycle. I don’t like Lycra and would rather cycle in everyday clothes because it’s more convenient for me (the only cycling-specific clothing I tend to wear is my fluorescent pink cycling jacket, so cars see me). I enjoy running my errands by bicycle but, if I don’t have somewhere to go, I tend to stay home.
  • I am a vehicular cyclist, partially. Vehicular cyclists want to be treated like any other vehicle on the road and they behave like any other vehicle on the road (this includes stopping at red lights, yielding to buses pulling out, not filtering through lanes, etc). Unfortunately, though, ‘vehicular cyclist’ is also the term ascribed to any cyclist who campaigns against cycling infrastructure because they believe that cyclists belong on the roads with any other vehicle (which I don’t). I’m of the opinion that I will use the roads and expect to be treated as any other vehicle on the road (admittedly, a slower one, perhaps not unlike a tractor), until there are safe cycling routes that are equal to or superior to the main roads in terms of convenience of use. It also means that I rage just as much as a car driver  when I see another cyclist flaunting the rules of the road.
According to this study by the Department for Transport (which I highly suggest everyone read), I can also be defined thus:
  • Reasons for Cycling: Experiential aspects of cycling
  • Ways of Cycling: Assertion

So, before you next start ranting about cyclists (or, if you’re a cylist, ranting about drivers), pause to consider — we cyclists are individuals, and that cyclist over there who just ran the red light was not me.

Digital Weddings

On a day like today, with the sun shining bright and the birds singing, the last thing I want to be doing is sitting at my computer, sorting the receipts for things we’ve bought for our wedding. Thankfully, we’ve got ourselves a shared Google Docs spreadsheet that’s keeping track of our budget, and a last-minute to-do list on the whiteboard.

Our friends will know that ThatScottishEngineer and I are both rather heavy tech-users.

When we began our wedding planning, we were thrilled that Google had created www.google.com/weddings which helped us keep organised. At the time, I was living in Cambridge and he was living in Newark, so most of our planning was done over Google Talk and using these shared spreadsheets. Our wedding website was set up using Google Sites and our RSVP was a Google Docs spreadsheet form.

But not everything is on Google’s servers. Our very-digital wedding registries are at Amazon.co.uk and Argos.co.uk. Invites were drawn in InkScape, our seating plan was drawn up in Microsoft Office Powerpoint, and all the letters I’ve had to send with cheques were written up in LibreOffice. Constantly having to move files from my Windows work machine to the Linux machine with the printer or my WordPress server has deepened my appreciation for both FileZilla and DropBox.

But what sort of documents are needed for a wedding that are well suited to the digital world? I didn’t think it would be that many until I got engaged and got started planning this massive project. Here’s a rough idea of what we’ve cobbled together:

  1. Website — Google Sites
    Just like context-sensitive HTML help! It helps if you make it clear to everyone that it’s being regularly updated and that they should check it frequently for changes. Not all grandparents understand RSS feeds.
  2. Invitations — Designed with Inkscape, printed on postcards from Moo.com. Digital until publishing, like some other items that I’m including in this list. No hand-drawing/writing for me!  In fact, doing these on the computer was not too different to flyers I’ve done before. Probably the easiest thing about the whole wedding was designing these.
  3. Guest list — Google Documents
    Name, household, address, phone number, email address, invites sent, kids ages (kids don’t count for the meal), etc.
  4. Photo shoot list — Google Documents
    A comprehensive list of all the shots I want taken (lists of guest names for each) of our wedding  day for my pretty album.
  5. RSVP spreadsheet — Google Documents
    Urgh, spreadsheet from HELL. Because it was a Google form, it ended up being very poorly formatted. Name, address, phone number, email address, which events attending (UK wedding, UK reception, US reception), whether transportation is needed to/from reception,  Dietary requirements…. I rather wish I’d done it in Microsoft Office Excel so I could colour-code it all, but it was attached to the RSVP and very much a Google Doc. Ended up copying most things over to the Guest List (#3).
  6. Seating Plan — Microsoft Office PowerPoint
    If you have £10 to spend, I’d suggest using www.toptableplanner.com. For the amount of time I’ve wasted fiddling with PowerPoint, it’s probably worth the cost.
  7. Gift Registry — Amazon.co.uk
  8. Gift Registry — Argos
  9. Thank You list — Google Documents
    Consolidated from the Gift Registry pages and extra notes of personal cards we’d gotten.

Those are just the digital documents. Certainly, though,  there’s a lot of scraps of paper in the expanding file folder on the shelf, including sketches of the wedding venue and schedules. But for the most part, this wedding has gone digital because it lets me collaborate with my partner and parents and anyone else who wanted to help.

So I guess digital is better for documents. When it comes to other things, though, I still suspect that an organist would be more reliable than an MP3 player…

“DOs and DON’Ts” or “Do’s and Don’ts”?

I was minding my business on the internet when I happened upon a review of the new Microsoft Manual of Style for Technical Publications on Kai Weber’s Tech Writing Blog. It was an interesting review (you should go read it) so I thought I’d have a look at what the going price is for the new Manual of Style.  A Google search for Microsoft Manual of Style took me to the Microsoft webpage on the third edition where I saw a bit of text that had my inner-editor shouting “NO NO NO!”.

Use technical terms correctly and consistently—including do’s, don’ts, and alternatives for usage.

When I was first taught about the apostrophe, the rules were simple:

  1. An apostrophe signifies a contraction
    Example: “I cannot” contracted to “I can’t”
  2. An apostrophe signifies possession
    “Alice’s new shoes”

But as I got further in schooling, there seemed to be this grey-zone of plurals which seemed better with apostrophes. Wikipedia mentions some such as when pluralising lower-case letters:

Be sure to dot your i’s and cross your t’s

It’s certainly not the “grocers’ apostrophe” that raises the hackles of copyrighters everywhere (Apple’s £1.50/lb). Surely nouns shouldn’t ever require an apostrophe to be pluralised… But what about those grey-zone ones?

Is the phrase do’s and don’ts correct in its punctuation?

It seems to me that it’s the pluralisation of do that seems to visually require the apostrophe. Without it, it risks being mis-read as a mis-spelling of does, or perhaps (Microsoft) DOS.

I, personally, would use DOs and DON’Ts, relying on the difference in capitalisation to make it easily readable. But which is right? I struggle to think of any other phrase that requires the pluralisation of do, this shortened phrase that means “A list of things to do and a list of things to not do”. Using the capitalisation also invokes the image of two side-by-side lists, topped by the words DO and DON’T. But does anyone agree with me?

I did another quick Google search for Do’s vs DOs to see what what the forums of English pedants might suggest. Here’s a quick summary of  the first few  Google hits:

Site Do’s Dos DOs
EnglishForums.com Y N No mention
Answers.com Y Y No mention
BeeDictionary.com Y Y No mention
DemocraticUnderground.com Y Y No mention

To be honest, a lot of the forums in the first page of hits seemed more concerned by the Don’ts, assuming that there SHOULD be an apostrophe in do’s so should it be written don’t’s. And no one seems to care about my solution of DOs.

Conclusion: These days, it seems like you can do whichever makes you happiest with this particular phrase. Oh, well. It’s a good thing I don’t use the phrase in documentation.

Inkscape and Scalable Vector Graphics

One of my current favourite open source drawing tools is Inkscape (available from Inkscape.org). I’m planning on giving a talk and/or tutorial about basic Inkscape drawing to the Falkirk Linux Users Group and Edinburgh Linux Users Group at some point over the coming months, so I’m using this space to get my ideas together.

A Bit About Scalable Vector Graphics

Once upon a time, I would have told everyone to use The GIMP for all their graphics needs, but these days I prefer Scalable Vector Graphics (SVGs) and The GIMP is a bitmap editor. SVGs allow me to resize the image without changing the quality of the image. However large or small,the image won’t become pixelated. Most of my drawings are used on business cards or websites so scaling isn’t too much of an issue, but I tend to release my artwork and photos under a Creative Commons Attribution license to anyone else who might want to use them – and they may want to put the image on posters, t-shirts, or billboards!

A Bit About Inkscape

Inkscape is Free (gratis). It’s also open source. It works on Windows, Mac, and also on Linux (which I have on two of my three computers). It’s a fairly lightweight application; outputs images as SVG, PDF, or the bitmap of your choice; and has a fantastically simple user interface. I used Inkscape and it worked beautifully for what I wanted to do, so I kept with it.

I’m not an Adobe Illustrator user – the work I did was never advanced enough to justify the expense of it (a single-seat subscription to Illustrator costs $29/month for a year*).  Since I only know about Inkscape, I’ll let other people on the internet explain the functional differences between Inkscape and Adobe Illustrator:

* according to the Adobe website (as of 06 January 2012)

A Bride and Groom as a Scalable Vector Graphic

A bride and kilted groom

I’ve done a half-dozen logos in Inkscape so far (which you can browse in my publicity portfolio). My most recent artwork was this drawing of a bride and Scottish groom for my wedding invitations.

From the beginning, my partner and I intended to create printed postcards instead of traditional wedding invitation cards. We planned to design them ourselves and get them printed, so off to Google I went  in search of inspiration. After a week of looking at thousands of different invitation designs in search of a design that I liked, I found one at weddinginvitations.co.uk.

The image wasn’t quite what I was looking for (not least because my groom will be wearing a kilt) so I thought I’d try my hand at re-drawing it as an SVG.  The company who printed our invitation postcards had design guidelines that suggested keeping the image in SVG format to ensure the best printing quality. In addition, I wasn’t entirely sure where we were going to be using the image, other than on the invitations and ‘Thank You’ cards. I could yet decide to put them on minicards to act as nametags on the tables, or make it an image on our wedding website. The flexibility of the SVG format is difficult to argue with.

Basic Inkscape Drawing

Rough shapes used for wedding couple drawing

I’d started creating the bride and Scottish groom image in Inkscape by freehand drawing with my Wacom tablet (as I’d done ages ago with a different drawing). After I finished sketching, I selected all the nodes and simplified them (Path > Simplify) to reduce the number of nodes but retain the curves. For example, a freehand line may have 50 nodes, but after simplifying there may only be 5.

I then realised that the shapes I was ending up with were incredibly simple — so I started over again, but using the bezier tool instead of the freehand tool. If you have a look at this basic shape drawing, you can see that the wedding dress in the image is effectively a triangle and the kilt is only a trapezoid.

Then it was down to making the lines curve the way I wanted them to. I did this by selecting individual nodes and using the node tools to make the node smooth (making it a curve instead of a sharp angle). When I did that, I also got handles for the node to adjust the direction of the curve. I adjusted the line between two nodes simply by clicking on the line and dragging it where I wanted it.

The whole wedding couple design was done with simple shapes, making making nodes smooth, and dragging lines around. I then did a bit of colouring but all the colours are solid so I didn’t have to worry about getting gradients correct.

The design is not very complicated, but I think its charm is in its simplicity.

A Talk and Tutorial on Inkscape

I’ll post here later about my talk and tutorial on Inkscape for Falkirk LUG and EdLUG.  I’ll also be sure to put my notes and/or slides here to share.  These are the topics I’m currently planning to cover. If there are any others that you feel need to be mentioned, please get in touch!

  • What is an SVG? How does it compare to a bitmap?
  • What is Inkscape?
  • How do I use the shape tools (square, circle, stars, spirals)?
  • How do I change the fill colour, line colour, and line thickness?
  • How do I combine and subtract shapes?
  • How do I use the freehand and calligraphy tools?

“Sounds like you need a writer.”

Most companies value documentation. I keep talking to software developers who’re working for small companies and they all say “yeah, our boss knows that its important to have documentation, that’s why he has us document as we code…”

It’s great that they know that having documentation increases the customers trust in the product or service. Unfortunately, there’s a “but”.

“But,” my friends tell me “I hate writing the documentation. And I always have to spend so much time figuring out how to write things. I know how to write code, but I’m not sure someone else would understand my documentation…”

Yes, a technical writer takes some time away from the developers, as they need to describe what a product is and how it’s meant to work. But we save time in the long run because we can just get on with the writing — and in the end, we tend to produce much higher quality content and a much better document than your stereotypical software developer.

If the developers at a company are spending a large chunk of their time writing documentation rather than coding, and there’s more work than people, then it may be worth looking into hiring a technical author instead of another developer. The developers you already have can spend more time writing the code they were hired to write and the technical writer can pick up and improve the documentation.

The quality of documentation your company produces is just as important as the quality of the software you write or the service you provide. If you give customers poor documentation, it could affect their opinion of your overall company image.

For more information, refer to the Institute of Scientific and Technical Communicator’s page on Why Use a Professional Communicator?.