Archief - SEARCH: how to document software?

Het archief is een bevroren moment uit een vorige versie van dit forum, met andere regels en andere bazen. Deze posts weerspiegelen op geen enkele manier onze huidige ideeën, waarden of wereldbeelden en zijn op sommige plaatsen gecensureerd wegens ontoelaatbaar. Veel zijn in een andere tijdsgeest gemaakt, al dan niet ironisch - zoals in het ironische subforum Off-Topic - en zouden op dit moment niet meer gepost (mogen) worden. Toch bieden we dit archief nog graag aan als informatiedatabank en naslagwerk. Lees er hier meer over of start een gesprek met anderen.
g

geronimoes

Legacy Member
Hallo iedereen,

Ik ben al een geruime tijd bezig om mijn eigen opensource framework (voor PHP5) te maken. Omdat ik geen held ben in het schrijven van documentatie heb ik dit steeds maar uitgesteld, waardoor ik nu mijn documentatie van 0 moet opbouwen.

Ik heb geen ervaring in het schrijven van documentatie, maar ik ken het framework wel van kop tot teen, dus zoek ik een beetje hulp.

Hoe begin ik? Welke structuur moet ik volgen? Zijn er templates die ik kan gebruiken? Welke software gebruik ik het beste?
Misschien zijn er hier ervaren documentalisten die me zouden willen coachen?

Een beetje meer informatie over het opensource framework:
J4PHP is an application framework inspired by STRUTS and IBATIS. This means it separates presentation logic, business logic and data access logic using the MVC and DAO pattern.
J4PHP does not port STRUTS or IBATIS to the PHP language however! J4PHP does not try to change how PHP works, J4PHP tries to extend PHP in an elegant way, while being as small and unobtrusive as possible.

How do I know J4PHP is something for me?
* You like to use PHPs object-oriented features, in fact you wish PHP was even more object-oriented than it currently is.
* You like to have a single clean configuration file which controls the flow of your application. You dislike having to remember 101 conventions and being bound by them in all possible ways.
* You like to be in total control of your application: you want to be able to extend the framework yourself.
Klik om te vergroten...

Bedankt alvast,

Jeroen

Ps. Ik weet niet of het toegestaan is een link te posten naar het project?
W

WHiSPy

Legacy Member
Unobtrusive en struts in 1 context? :D

Welke documentatie heb je nodig? Technische? Een FAQ?

Voor technische documentatie kan je altijd eens naar phpdoc kijken: http://www.phpdoc.org/. Dat is in dezelfde stijl als javadoc.
g

geronimoes

Legacy Member
Nee, ik zoek geen documentatie generatie tool, de bedoeling is dat ik de documentatie zelf schrijf.
Documentatie die een antwoord geeft op de volgende vragen:
- Wat is het framework?
- Hoe gebruik ik het framework?
enzovoort
d

dJeez

Legacy Member
Als het de bedoeling is van de code ooit beschikbaar te maken aan het grote publiek (wat mij hier het geval lijkt) zou ik er minimaal toch ook voor zorgen dat die gedocumenteerd is, en dan is phpDoc idd wel een aanrader.

geronimoes zei:
Ps. Ik weet niet of het toegestaan is een link te posten naar het project?
Klik om te vergroten...
Aangezien het om een Open Source project gaat (en het dus ook niet puur commercieel is), mag je de link hier zeker posten. Dat kan misschien nog nuttig zijn om medewerking/feedback/bugtesters te krijgen (voorzover je dat wil uiteraard).

Nu, ik vermoed dat het deze is : J4PHP?
g

geronimoes

Legacy Member
Djeez, dat is inderdaad de sourceforge pagina van het project.
Voor de volgende release (waarbij een hele hoop veranderd en verbeterd is) ben ik echter bezig om een wiki te vullen met documentatie:
http://wiki.j4php.org/doku.php?id=j4php:start

De actuale code kan je reeds op de wiki bekijken of je kan deze downloaden via svn ( svn co https://j4php.svn.sourceforge.net/svnroot/j4php j4php).

Als je wil kan je zelf eens kijken naar de code, de demos geven een goed beeld hoe het framework gebruikt moet worden (je kan het makkelijk bekijken hier: http://wiki.j4php.org/doku.php?id=j4php:source:start).

Iedereen die zich geroepen voelt mag natuurlijk meehelpen om het project te documenteren.

frenzal: Ja de documentatie van codeigniter is heel overzichtelijk. De schrijver ervan heeft duidelijk meer ervaring dan ik :p, maar ik geef de moed nog niet op!
Het archief is een bevroren moment uit een vorige versie van dit forum, met andere regels en andere bazen. Deze posts weerspiegelen op geen enkele manier onze huidige ideeën, waarden of wereldbeelden en zijn op sommige plaatsen gecensureerd wegens ontoelaatbaar. Veel zijn in een andere tijdsgeest gemaakt, al dan niet ironisch - zoals in het ironische subforum Off-Topic - en zouden op dit moment niet meer gepost (mogen) worden. Toch bieden we dit archief nog graag aan als informatiedatabank en naslagwerk. Lees er hier meer over of start een gesprek met anderen.
Terug
Bovenaan