![]() Good documentation is not just about the reader, though. This way, you won't scratch your head trying to figure out what you were thinking when you put that notebook together. That can later be improved, but first, you need to write it! Even if you are the only person to read this documentation, perhaps on a future iteration of that data science project, it's good to do it properly. As long as the reader can understand what you are doing without having to dig deep into the code (or even worse, run parts of the code), your documentation is a decent first draft. Do you think their creators were technical writers? The same goes for other kinds of documentation available online. Just take a look at the documentation of the most mature packages in Julia. You don't need to be a technical writer to write good documentation. But why is documentation so valuable? What about visuals? Aren't they worth (at least) 1000 words each? What's the point of dressing up our code notebooks with text too?įirst thing's first. Interestingly, even if you are the most charismatic communicator out there, if you don't express your communication skills in your documentation, your data science work will suffer. The funny thing is that even though many people value communication in data science, not everyone can link good communication and good documentation. Good documentation is in high demand everywhere, from coding libraries to products and services to even data science projects. I'll keep you posted through this blog regarding updates on the book. ![]() Hopefully, I'll be able to focus more on other projects now. So, at least, I didn't get bored, plus I was a bit imaginative with a couple of the problems I tackled in the code notebooks.Īlthough it's a bit soon to tell when the book will be out, at least the most time-consuming part is behind me now. This book project involved both text, images, and code (in the form of a new type of code notebook, for Julia). ![]() So, I reached out to my publisher, sent him a proposal with an outline of the book, and before long, I was good to go!ĭuring these months I had been writing regularly (pretty much daily, at least on weekdays), with just a couple of weeks off, one for the Christmas holidays and one for the preparation of my podcast. Of course, I could have just shared some code or perhaps put together some article, but the idea deserved more. I didn't have to, but the idea was burning me, and as I had been working on a particular data science topic the previous months, I felt it deserved to be shared with a larger audience. About five months ago, I started writing a new technical book. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |