Re: Documentation best practices

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Definitely split it up.  Documentation is far more useful if it's organised
in a sensible way. You may also want to check out readthedocs.org for
somewhere to host a rendered version.

On Thu, 26 Mar 2015 09:52 Ashley Sheridan <ash@xxxxxxxxxxxxxxxxxxxx> wrote:

> I know this isn't strictly PHP, but I thought the collective knowledge
> here is better than what I'll get on stack overflow!
>
> Basically, I have a project I'm working on in my spare time, and so far
> have been documenting the whole thing in one large readme on github. A
> print preview puts it at ~16 pages.
>
> The project has a lot of scope for growth, so documentation will only
> increase.
>
> My question is, when does it become worth breaking one large document into
> several smaller chunks? What are your own views on this? Has anyone had a
> similar issue in the past?
> --
> Sent from my Android device with K-9 Mail. Please excuse my brevity.

[Index of Archives]     [PHP Home]     [Apache Users]     [PHP on Windows]     [Kernel Newbies]     [PHP Install]     [PHP Classes]     [Pear]     [Postgresql]     [Postgresql PHP]     [PHP on Windows]     [PHP Database Programming]     [PHP SOAP]

  Powered by Linux