DeveloperStable

Writing documentation

Voice, structure, and required sections.

Audience: All usersRead: 5 minEdit on GitHub

Overview

Writing documentationVoice, structure, and required sections.

This page is part of the Developer Portal portal. The portal covers everything an external contributor needs — setup, coding standards, testing, review, and release. includes the adr archive and pointers to good first issues.

When to use it

Reach for documentation when the problem in front of you matches its scope: voice, structure, and required sections.

  • You need a canonical answer that survives environment changes.
  • You want the behavior documented under a stability contract.
  • You are cross-referencing this material from another portal.

How it fits

Each portal in NeuronScope owns one axis of the library. Developer Portal owns contribute to neuronscope. Sibling pages in the sidebar cover the adjacent surface area — start there if this page does not answer your question directly.

Next steps

Related