Online vs Offline Documentation

Envato Authors CodeCanyon
1

Hey,

I am currently creating a PHP script and I want to provide a fair bit of documentation with it to cover all aspects for customisation etc. However I am not sure wheter I should create all my documentation in web form and store it online or should I provide an offline word document? I like the idea of online as I can update it easily, things can be searched for etc, but if I opted for that, what do I say in the documentation included with the script? “Go here for docs -> website”?

Any replies would be greatly appreciated!

Thanks,
Mark

2

As far as I know, offline documentation is mandatory as for now. Lately, what I do, is to compose an online doc online at https://www.gitbook.com and just before submitting my item I download it’s PDF version from this site and zip it with the item bundle.

3

Ah okay thats perfect! Probably best to have offline documentation, your right! Would it be necessary to have online documentation too?

4

No, online documentation is completely optional.

5

Perfect thank you for your help :grinning:

1 Like