From b227b7c2e235d38b0c611945200fb74c4c3129c1 Mon Sep 17 00:00:00 2001 From: KevinMDuarte Date: Thu, 22 Nov 2018 05:11:13 +0100 Subject: [PATCH] Added actual document information (#22451) Basic information on creating a document next to just commenting and writing smart code --- guide/english/documentation/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/guide/english/documentation/index.md b/guide/english/documentation/index.md index a609802394..395a6ace32 100644 --- a/guide/english/documentation/index.md +++ b/guide/english/documentation/index.md @@ -17,11 +17,11 @@ Think of Code documentation as a history textbook. It allows current developers ![An example of commenting in the real world](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg) - +Even though the code itself should always be self explanatory, it is often good to have a document along with the code files that describes it into more detail. The idea of such a document is not only to cover the technical parts so that contributors are able to add or change the code but also for people wanting to use the program. For that reason, it is for example good to have a guide on how to use the created program and some examples along with it. Documents become especially important for bigger projects since it can be a lot more time consuming and complicated to understand a program by just reading its code compared to an explanatory document. +If the program uses already existing material such as libraries or is based on some other projects, it is always a good idea to mention those in the document since it is part of the foundation. + #### More Information - - *[Medium Article about Code Documentation](https://medium.com/@andrewgoldis/how-to-document-source-code-responsibly-2b2f303aa525)