Toolverse
All skills

rust-docs-guidelines

by RediSearch

Guidelines for writing Rust documentation

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Category
Backend
Views
25

About this skill

Guidelines for writing Rust documentation

How to use

  1. Włącz tę umiejętność w swoim Claude/Copilot, gdy przygotowujesz dokumentację do projektu Rust. 2. Gdy wyjaśniasz nowe pojęcie (typ, funkcję, stałą), zrób to dokładnie raz w głównym miejscu dokumentacji – tam, gdzie pojęcie jest najbardziej istotne. 3. We wszystkich pozostałych miejscach, gdzie odwołujesz się do tego pojęcia, użyj wewnętrznego linku (intra-documentation link) zamiast powtarzać wyjaśnienie. 4. Zawsze linkuj symbole Rust – typy, funkcje, konstante – używając składni dokumentacji Rust, aby czytelnik mógł szybko przejść do definicji. 5. Zamiast pisać "patrz linia 42", dodaj komentarz bezpośrednio w kodzie funkcji lub metody, jeśli dokumentacja musi być przywiązana do konkretnego fragmentu. 6. Skupiaj się na uzasadnieniu decyzji projektowych i zachowań (dlaczego coś działa w ten sposób), a nie na szczegółach implementacji – unikaj trywijalnych wyjaśnień w komentarzach liniowych.

Related skills