<div dir="ltr"><div class="gmail_default" style="font-size:small">Hello everyone,</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">Hope everyone is doing well.</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">How do we document Squeak?  There are class comments (mostly), there are books and papers, but when we want to develop a detailed spec about something, what is the best way to do that?  <br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">Requirements:</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">1. We need something that is easy enough for people to contribute.</div><div class="gmail_default" style="font-size:small">2. Something that is easily maintained and modified</div><div class="gmail_default" style="font-size:small">3. Something that is collaborative </div><div class="gmail_default" style="font-size:small">4. Something that is easily discoverable</div><div class="gmail_default" style="font-size:small">5. Something that is not easily ignored</div><div class="gmail_default" style="font-size:small">6. Something that can be tested! </div><div class="gmail_default" style="font-size:small">7. Something that can be versioned</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">There are existing options like our swiki and github readme, or github pages. </div><div class="gmail_default" style="font-size:small">There are third party tools available (<a href="https://readthedocs.org/">https://readthedocs.org/</a>) or (<a href="https://www.sphinx-doc.org/en/master/">https://www.sphinx-doc.org/en/master/</a>) which may be good but raise the bar for contributions. </div><div class="gmail_default" style="font-size:small">Maybe a loadable package that includes searchable documentation and tests. An Active Essay? (<a href="https://www.playfulinvention.com/emergence/active-essay.html">https://www.playfulinvention.com/emergence/active-essay.html</a>).</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">How do we, as a community, want to do docs?</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">Thanks,</div><div class="gmail_default" style="font-size:small"><br>Ron Teitelbaum</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"><br></div></div>