Question

how to prepare project documents ready?​

Answer 1

Answer:

first of all u have to think about topic and then about metter

Answer 2

Answer:

Here are few tips :-

• Include A README file that contains

• A brief description of the project

A brief description of the projectInstallation instructions

• A short example/tutorial

• Allow issue tracker for others

• Write an API documentation

• What a function do

• What the function's parameters or arguments are

What the function's parameters or arguments areWhat a function returns

• An example for code documentation.

• Document your code

Document your codeApply coding conventions, such as file organization, comments, naming conventions, programming practices, etc.

• Include information for contributors

Include information for contributorsInclude citation information

Include information for contributorsInclude citation informationInclude licensing information

• Link to your e-mail address at the end

• List all the version of the files along with the major edits you did in each version

...❤️My Ans...

◆•◆•◆DarkAngel◆•◆•◆