Sovellus dokumentaation tekemiseen

HTML, php, JavaScript, .css, käytettävyys, saavutettavuus, kuvankäsittely...

Sovellus dokumentaation tekemiseen

ViestiKirjoittaja Teem » Pe Tammi 21, 2011 18:44

Arvoisat kanssakeskustelijat,

Mahtaisiko teillä olla hyviä vinkkejä ohjelman (PHP, MySQL, Apassi, ym. pikkuhiluja) dokumentaation tekemiseen. Kyseessä on eräänlainen suljetun lähdekoodin sovellus - eli tarkoituksena ei ole tehdä avointa dokumentaatiota kaikille vaan pikemminkin ohjenuora itselle ja muille mahdollisille koodinkirjoittajille, jotka pyöritävät saman hankkeen parissa. Dokumentaatioon on siis tarkoitus saada työnnettyä kaikki yleinen ja yksityiskohtaisempi tekninen höpinä ko. sovelluksen sielunelämästä. Eli siis käytännössä kaikki se, mitä joku tarvitsee päästäkseen kärryille sovelluksen toiminnasta ja siinä käytettävistä ajatusmalleista.

Toivottavaa tietysti olis, että kyseistä työkalua voisi käyttää verkossa (lähi taikka sitten ihan wöörld wide). Saisi olla maksuton käyttää - mutta hyvästä toki voi maksaakin jokusen lantin. Meidän käytössä on tällä hetkellä PHP Eclipse, joka todettu varsin päteväksi tarkoitukseensa nähden.

- MediaWikiä on kokeiltu, mutta sen käyttö tuntu jotenkin nihkeltä - kenties hyvä wysiwyg editori muokkaukseen auttaisi asiaa. :roll:
- Pari eri CMS -sivustopohjalla toimivaa viriteltää, tällä hetkellä nro 1 vaihtoehto, mutta ammattimaisempaa ratkaisua kaivataan.

Ideoita, vinkkejä, ajatuksia ja kaikkea noiden ympäriltä otetaan kiitollisina vastaan.
Käyttäjän avatar
Teem
 
Viestit: 4
Liittynyt: Ke Tammi 12, 2011 15:07

Paluu Web-suunnittelu & koodaus

Paikallaolijat

Käyttäjiä lukemassa tätä aluetta: Ei rekisteröityneitä käyttäjiä ja 2 vierailijaa