DDRescue-GUI’s documentation is released, finally!

Hi everyone,

The user guide for DDRescue-GUI is now done!

Get the documentation here, and you can find the source code here.

I’ve been working on this for a while now, but it is finally ready. I originally wanted to live the developer dream of never documenting because “it’s simple enough to use without documentation”. I realised fairly quickly that this wouldn’t work, but still took a while to decide what to do. A few people asked me about user guides, so I decided to write one.

As a user guide, this will help with general usage as well as the advanced functions. I have provided screenshots for both Linux and macOS, so it is easy to understand for everyone. I’ve also clarified a few technical terms people seem to trip over, like the difference between a mapfile and the recovery logfile, and DDRescue-GUI’s logfile.

The documentation is available online, as well as in PDF, and EPUB formats for e-readers, with the idea that it will be viewable on all operating systems and devices. I’ve made sure to write it in plain English, even when describing technical terms, to try and keep the learning curve shallow. Also, I’ve provided information on what you should do when, for example, your recovery finished okay, but your data is still corrupted, so it may be useful as a general guide as well as a guide specifically for DDRescue-GUI.

Future Plans

I hope to have documentation up for my other programs soon as well, but it will depend on my workload and other priorities, such as writing Stroodlr, and re-writing Wine Autostart. I’m also studying for a degree part time and volunteering, but I’ll do my best 🙂

The Wine Autostart documentation will probably come last, because I need to re-write it first 🙂

Reminder:

Get the documentation here, and you can find the source code here.

That’s about it from me, so see y’all soon,
Hamish

Tagged , , , , . Bookmark the permalink.

About Hamish McIntyre-Bhatty

I'm currently studying for a Computing and IT degree with the Open University, and am a software developer as well. I enjoy coding in Python, C++ (still learning), and Java. Having written 4 open-source programs (hosted on launchpad.net), set up my own website, and started volunteering at Wimborne Model Town to work on their river control system, I still find the time to enjoy cycling, acting, photography, and playing bass guitar. I go climbing every now and then as well. More recently, I wrote my first commercial program, Disk Verifier, and created a PSID Unlocker GUI for Parted Magic. I also create tutorial and other informative videos for Parted Magic LLC.

4 Responses to DDRescue-GUI’s documentation is released, finally!

  1. Nick Woolard says:

    Hi Hamish
    I’m impressed with DDRescue-Gui but having started it, my PC crashed and I can’t see in the documentation how I use the mapfile I created to restart the process. Could you help me, please?

  2. Nick Woolard says:

    Thanks Hamish, that was helpful. If I may make a suggestion to improve prominence, I think it might be logical to have a heading (perhaps in Chapter4) labelled “How to use a Mapfile” with the explanation there.

Leave a Reply

Your email address will not be published. Required fields are marked *