<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by Anule Ndukwu on Medium]]></title>
        <description><![CDATA[Stories by Anule Ndukwu on Medium]]></description>
        <link>https://medium.com/@anule.ndukwu?source=rss-c4e432c99a88------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/0*eAZ-8meRbpsCNGE1.</url>
            <title>Stories by Anule Ndukwu on Medium</title>
            <link>https://medium.com/@anule.ndukwu?source=rss-c4e432c99a88------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Sat, 21 Nov 2026 19:16:38 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@anule.ndukwu/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[How Knitting Helped Me Understand the Importance of Documentation]]></title>
            <link>https://medium.com/@anule.ndukwu/how-knitting-helped-me-understand-the-importance-of-documentation-fde4a0c8a0a8?source=rss-c4e432c99a88------2</link>
            <guid isPermaLink="false">https://medium.com/p/fde4a0c8a0a8</guid>
            <category><![CDATA[knitting]]></category>
            <category><![CDATA[technical-documentation]]></category>
            <category><![CDATA[programming]]></category>
            <dc:creator><![CDATA[Anule Ndukwu]]></dc:creator>
            <pubDate>Mon, 20 Nov 2017 06:46:42 GMT</pubDate>
            <atom:updated>2017-11-20T06:46:42.999Z</atom:updated>
            <content:encoded><![CDATA[<p>Every autumn, I start a new knitting project in preparation of the cold days ahead. I find knitting to be a very satisfying pastime. It’s handy, soothing in its rhythmic repetition, and always produces <em>something</em>, useful or otherwise.</p><p>Much has been written about the similarities between knitting and programming. When I started to learn Javascript, I noticed that my interest in both activities stemmed from the same desire to see a project through to completion. How purl and knit bear a striking resemblance to binary numbers 0 and 1. How pattern notations echo regular expressions.</p><p>I noticed how knitting gets represented as simply ‘women’s work’, much like the beginnings of software engineering, as though there is anything simple about constructing structural pieces from a two (or more) sticks and one continuous strand of yarn. As though there is anything wrong with a woman at work.</p><p>Still, the analogy felt incomplete. What draws me to both knitting and coding are the communities that drive innovation out of devotion and curiosity, in which techniques are formed and norms established. With the right combination of search terms, one can find an active message board or comment section, each post threaded together with an undercurrent of excitement. But, how are these new ideas saved? More importantly, how do newcomers access and digest this information? The key is documentation.</p><p>Documentation is the conduit through which coders communicate their ideas and approaches. In knitting, the analog is called a pattern. Both iterations contain instructions on how to digest the information being presented. However, the problem lies within the inconsistent quality of these documents.</p><p>For example, my projects for this autumn were a fashionable, chunky-knit, oversized sweater and a pair of practical, plain mittens. Both were made using simple techniques and stitches. However, the mittens were significantly more challenging to complete. Why? Because the pattern was poorly documented and difficult to reproduce. This pattern was found in a knitter’s forum. At first glance, the steps appeared in a logical order but, as I began to work on the first mitten, it became quite evident that this pattern was less of a well-crafted document and more of an ad-hoc attempt at pattern design with a very specific person in mind. The measurements were inexact approximations of a hand and I had to frequently alter my stitch count from the one in the pattern in order to ensure an even outcome. In programming terms, this project had an extremely confusing and poorly maintained code base. There were interesting approaches and concepts within, but they were poorly executed.</p><p>On the contrary, the sweater pattern was clear and consistent throughout the entire document. All measurements were given in metric and English notation and all stitches were accounted for at every step. It was as though the pattern maker had taken the time to refactor their initial product to ensure that it could be easily reproduced.</p><p>I found this experience to be analogous to my experience with API documentation. The documentation which was written for the engineer’s own reference was always lacking next to the documentation written with others in mind. At first, I took that disparity to just be ‘how it is’. I now understand what a disservice those engineers are doing to their product. Writing and maintaining accurate documentation is not just a way to keep track of one’s progress, it is how other engineers and developers interact with new ideas and approaches. No matter the idea, brilliance can always be muddled by poor execution.</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=fde4a0c8a0a8" width="1" height="1" alt="">]]></content:encoded>
        </item>
    </channel>
</rss>