Commentary:

There is a special approach for coders to communicate with each other, and that is the code documentation. With this special approach, coders do not need to talk to express their information, and for this writing, I am trying to analyze the kind of genre, code documentation and let people know about how to write in the right way. 

My biggest challenge for this project is the particularity of the genre: the code documentation. This genre is very different from others. Unlike reports, which may contain introduction, investigation, and conclusion, the code documentation does not have a specific requirement for the contents that should be involved. In this writing, I focused on the two main types of code illustrations, ReadMe and the documentation above the code, to analyze.

Another challenge is that, unlike the other genres, the code documentation mainly consists of sentences rather than graphs. With other genres, the relationship among each graph could be analyzed. Simultaneously, for code documentation, there always exists one sentence for the method statement, and the next sentence would be the function of the next method, which might be no relationship with the current one.

After this writing, I have learned a lot. The first thing I have learned is how to analyze writing rhetorically. I have never learned how to do it before, and now I knew that I need to analyze writing from different aspects like the audience, purpose, language…

When going through others’ analyses, I learned that I should use efficient examples to support my analysis. Only focusing on narrating will lead to an unreliable analysis. I had this problem, and I need to pay attention to it in my future writing.

Another technique I learned is to use subtitles. This is the first time I used subtitles in my writing, and I felt it helped me build a clear and logical essay. Each subtitle will serve as a hint for me to write some content about that topic. I will use the subtitle as well in the future.