What is documenting a source?
Documenting means showing where you got source information that’s not your own. Remember, a research paper blends your ideas with ideas and information from other sources. Documentation shows the reader what ideas are yours and what information and ideas you’ve taken from a source to support your point of view.
How do you do documentation?
Best Practices for Documenting Your ProjectInclude A README file that contains. Allow issue tracker for others.Write an API documentation. Document your code.Apply coding conventions, such as file organization, comments, naming conventions, programming practices, etc.Include information for contributors.
What is effective documentation?
Effective Documentation is a major sourcebook that offers technical writers, editors, teachers, and students of technical communication a wide variety of practical guidelines based on often hard to find research in the usability of printed and electronic media.