documentation

Skill — Documentation

This skill defines how to document code, modules, and learnings on a project using Lytos. An agent loaded with this skill knows what to document, in what format, and when to update the project memory.

---

When to invoke this skill

• After writing or modifying a public function
• After a sprint, to consolidate learnings into the memory
• When creating a new module or component
• To write or update an issue

---

Code documentation

Universal principle

Every public function and method must be documented. The format depends on the language, the content is the same:

1. First line: what the function does (infinitive verb)
2. Parameters: type + name + one-sentence description
3. Return: type + description, including edge cases (empty list, null, error)
4. Errors: each possible exception or error with its condition

Examples by language

def calculer_ttc(prix_ht: float, taux_tva: float) -> float:
    """Calcule le prix TTC à partir du prix HT et du taux de TVA.

    Args:
        prix_ht: Le prix hors taxes en euros.
        taux_tva: Le taux de TVA (ex: 0.20 pour 20%).

    Returns:
        Le prix TTC arrondi à 2 décimales.

    Raises:
        ValueError: Si le prix HT est négatif.
    """

/**
 * Filtre les produits selon les critères donnés.
 *
 * @param {Product[]} produits - La liste complète des produits.
 * @param {FilterCriteria} criteres - Les critères de filtrage à appliquer.
 * @returns {Product[]} Les produits correspondant aux critères. Tableau vide si aucun résultat.
 */
function filtrerProduits(produits, criteres) {

// CalculerTTC calcule le prix TTC à partir du prix HT et du taux de TVA.
// Retourne une erreur si le prix HT est négatif.
func CalculerTTC(prixHT, tauxTVA float64) (float64, error) {

/**
 * Calcule le prix TTC à partir du prix HT et du taux de TVA.
 *
 * @param float $prixHT    Le prix hors taxes en euros.
 * @param float $tauxTVA   Le taux de TVA (ex: 0.20 pour 20%).
 * @return float Le prix TTC arrondi à 2 décimales.
 * @throws InvalidArgumentException Si le prix HT est négatif.
 */
public function calculerTTC(float $prixHT, float $tauxTVA): float