Answer the question
In order to leave comments, you need to log in
A lightweight web project documentation program?
Tell me a program (or online service) for maintaining documentation on the website.
For 6 years, the project has become quite bloated, and it has already become difficult to keep all the dependencies in mind.
Comments in the code are clearly not enough.
While I work alone, so such giants as Microsoft Project do not fit
what you need:
build communication diagrams + a detailed description for each block (Plain Text is not suitable) I
tried Visio, it’s fine with diagrams, but it’s not convenient with documentation
And I will be grateful if you tell me resources like write documentation for a web-project/database
How much I searched on the Internet, everything is focused on large multi-user projects, but you need something with which you can quickly start without spending a lot of time learning.
Documentation is written mainly for me and the boss.
Answer the question
In order to leave comments, you need to log in
Start with a simple Wiki. For example, in Trac (you may already be using it) it is quite good. For charts, you can use the Graphviz plugin.
For the database, I recommend SchemaSpy. Able to draw diagrams using the same Graphviz.
Decided what I want, but have not yet found solutions.
I would like to build a diagram and so that when you click on the block on the left/bottom, the editable (rich text) description is displayed in the panel.
SQL Server also copes with the diagram for the database, and a lot of other programs, but with the second part of the requirement (a panel with a convenient description). While I was looking, I found a number of beautiful, advanced solutions, maybe someone is interested:
Creately - the description for the sheet as Rich Text Edit wanted, but the description for the block is a short textbox
Cacoo
Giffy
LovelyCharts
but unfortunately they either don’t have a description field for the block at all, or small PlainTex block in the Properties field
we used doxygen - allows you to generate class diagrams from the code.
According to the database - I don’t know. We use comments to fields and tables,
reingeneering the database into a diagram (logical parts) any visual tool: MySQLWorkbench (not very convenient), DBDesigner4 www.fabforce.net/downloads/
Didn't find what you were looking for?
Ask your questionAsk a Question
731 491 924 answers to any question