N
N
Nazar Mokrinsky2012-12-22 21:50:09
PHP
Nazar Mokrinsky, 2012-12-22 21:50:09

A tool for writing and maintaining up-to-date documentation for an Open Source project?

I am developing a CMS, I would like to make documentation for it so that third-party developers can see and understand what's what.
In principle, there are PHPDoc sections all around, you can generate documentation on the fly, but it turns out to be somehow dull, I would not want to stick examples of use in the description of methods and classes.
It would be nice to do something in the form of a simple tutorial for the initial start, but you would also need to have complete documentation. I thought to maintain a wiki on GutHub, but it turns out to be inconvenient, updating everything manually is also too difficult.
Maybe screencasts?
What tools do you use, how to minimize the threshold for entering the project for new people?

Answer the question

In order to leave comments, you need to log in

3 answer(s)
O
OCTAGRAM, 2012-12-22
@OCTAGRAM

I once paid attention to lp4all : we write wiki pages in separate files, we write wiki inserts in source files. HTML pages are made from both of them, source files are colored, wiki inserts are formatted in them , documentation and source codes can be cross-referenced to each other. After all, sometimes it’s easier to see how it’s really done, especially if the documentation is not often updated.

C
cyberorg, 2012-12-22
@kyberorg

We have this: if someone asks a question about your piece of code, instead of answering, you write an article in the internal wiki with the answer to the question.

N
Nikolai Turnaviotov, 2012-12-23
@foxmuldercp

Some IDEs have the ability to write XML comments in a separate file, torn directly from the source. I appreciated this functionality in MS VS12 - an xml file is placed next to the assembled project.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question