![]() ![]() In this article, we delve into the crucial role technical documentation plays in software development. Best practices for creating and maintaining your technical documentation Reading time: 24 minutes.Documentation is the collaborative effort of all team members.Keep your software documentation up to date.How to write software documentation: general advice.Specialized architecture samples: AWS, Microsoft Azure, and Google Cloud. ![]() Quality assurance documentation templates.General project documentation templates.Samples and templates for software documentation.Agile and Waterfall approaches to software documentation.What is technical documentation in software development?.I use the Premium account to get offline notes on my iPad, but the free version goes a very long way for most people. There are also a range of other criteria that are relevant to consider, which I won’t go into here – for example, their user interface is very different. If you’d like to save a bit of money, Evernote gives you a lot for free. The conclusion? It basically comes down to individual needs and preferences. Make voice annotations and also import a range of files and media. View pages side by side – very useful when reviewing literature. Thematic notes can be ‘assessment’, ‘professionalism’, and so on, where I discuss different dimensions of a concept, theme or theory – then I link to source notes where relevant, which are the notes I make for individual publications.Ĭhoose a range of formatting options for your text, such as bold, italics, underline, and different fonts and colours. For example, I often have thematic notes that I then link with source notes. This is extremely useful for organising your notes. The user interface has a nice short cuts and recent notes menu, which makes it easy to access your most important/recent notes.Ĭreate links between different notes. Powerful search function where you can easily search across all your notebooks, and also attached PDFs. You can share your notebooks, as read only for free accounts, with editing features added with paid accounts. I can email notes directly to Evernote, and add tags and the designated notebook in the process. A lot of my apps communicate directly with Evernote, including Postbox, Safari (through the web clipper), Cloud Outliner, Curio and MagicalPad. You can also create one level of hierarchical tags, in addition to using notebooks as a form of organisation.Įvernote has great integration with other apps. I’m a big fan of tagging as a form of organising notes, and Evernote does this extremely well. Evernote syncs seamlessly across everything.Įvernote has an efficient system for tagging each note. For me, this is a huge bonus, as I work in a Windows environment, have a mac and iPad, and also an android phone. – proper hand writing features in the iPad versionĮvernote works on ‘everything’. ![]() – lack of consistency in formatting between mac and iPad (it’s not too bad – it’s just not consistent) The physical notebook-looking interface – working with CPN on the iPad is a bit like browsing through a ‘real’ notebook. This is very useful for recording lectures, or for any other context where you are combining audio notes and written notes. In the mac version, you can link to files on your mac without actually importing the file into the notebook.ĬPN can synchronise text and audio notes. The multidex (see my previous post) – you’ll never not find anything again. Having said that, the hand writing feature is not very advanced compared to apps such as Notability or 7NotesHD – BUT if you need to sketch a quick diagram, figure or table while you are entering text, you can. You can combine text input with hand writing on the iPad version. It’s a great way of organising pieces of text across a large number of notes (or pages, as they are called in CPN). I absolutely love this feature, and CPN is, to my knowledge, the only note taking app for mac that offers tagging of text (as opposed to tagging of a whole note). You can tag cells of text in outline mode. It makes it very easy to distinguish between author’s text, own ideas, and to organise concepts in hierarchical relationships to each other. I’ve written in more detail about this in previous posts – but CPN really excels for outlining, which in turn is an extremely useful way of writing up literature notes. Rather than full reviews, here are my initial thoughts on some of the pros and cons of each app: However, Evernote is a strong contender and recently I have considered doing more of my academic work in Evernote. In several previous posts on this blog (see some links below), I have sung the praises of Circus Ponies Notebooks, and I still think it’s one of the best note taking apps around for mac. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |