Keskustelu: Yleinen keskustelu: Online dokumentaation tekeminen?

Sellainen kysymys olisi, että jos tekee vaikka koodaus projekteja kaverin kanssa, niin olisiko mitään saittia tai nopeata tekniikkaa, millä voisi kootaa dokumentaatiota projektista niin, että molemmat/tai kaikki kaverit voivat muokata dokuentaatiota/tekstiä siten, että muutokset näkyy välittömästi kaikille kavereille, jotka selailevat dokumentaatiota.
Eli vähän niin kuin tarttisin tekniikan jakaa tekstiä, jota kaikki voivat muokata wikipedia tyyliin.

Onko valmista ohjelmaa tai palvelun tarjoajaa, vain kannattaisko itse vääntää php:lä joku alkukantainen systeemi?

PHP:llä ja html formilla saisi tehtyä sen nettisovellukseksi, mutta itse tekisin vaikka C++:lla ohjelman, joka ottaisi FTP yhteyden serveriin ja siirtäisi sinne tarvittaessa. Sitten vielä siihen ohjelmaan koodin väritykset sun muut, niin tulee hyvä. Ei edes mikään kovin vaikea varmaan toteuttaa.

Riippuu nyt, millaisesta dokumentaatiosta puhutaan. Vapaamuotoiseen (selostavaan) dokumentaatioon wiki on aivan toimiva väline. (Kannattaa valita jokin suhteellisen kevyt versio.) Jos taas on tarkoitus dokumentoida itse koodia (luokkia, funktioita jne.), tähän on muita välineitä, jotka hakevat kommentit koodista. Yksi tällainen on Doxygen.

Itse kokeilin yhdessä PHP-projektissa javadoc-tyylistä kommentointia/dokumentointia ja sitten generoin Doxygenillä html-version sen pohjalta. Ihan OK ratkaisu ainakin kyseisessä projektissa, kun kyseessä oli rajapinta jonka käyttö oli suunnattu vähän edistyneemmille ohjelmoijille muutenkin. Tietty ei kata kaikkia tarpeita ja tuottaa lähinnä dokumentaation toteutetusta rajapinnasta.

Google Docs voisi toimia jo mainittujen ohella.

Alkukantainen systeemi:

<?php
# index.php
$vie = file_get_contents("viestit.txt");

echo "<form method='POST' action='laheta.php'>
<input type='submit' value=' Tallenna ' name='d1'><br>
<textarea type='textarea' name='viesti' rows='40' cols='66'>$vie</textarea><br>

  </form>";
?>

<?php
# laheta.php
if (!isset($_POST['viesti'])) {
} else {
   $tiedosto = fopen("viestit.txt", "w");
   $viesti = $_POST['viesti'];
   $viesti = stripslashes($viesti);
   $viesti = htmlspecialchars($viesti);
   fwrite($tiedosto, $viesti);
   fclose($tiedosto);
   header("Location: index.php");
}
?>

Ja samaan kansioon viestit.txt
Välillä kannattaa ottaa varmuuskopioita.
En kyllä suosittele tällaisena. :D

Itsekin suosittelisin Doxygenia, se on mainio työkalu.

Kiitokset avusta, enköhän näillä avuilla selviä. Metabolixen wiki ehdoitus saattaa olla kaikkein nopein ja helpoin ratkaisu. Mutta kiitokset kaikille!