<div dir="auto">Hi Hilaire,</div><div dir="auto">I have a couple of suggestions:</div><div dir="auto">If only comments are changed, I’d try to keep the original author initials.</div><div dir="auto">Also, I’d suggest to focus on documenting the main protocols instead of internal details that might change.</div><div dir="auto">And finally a thing I do in my projects: when I have a hierarchy of classes and a method is implemented in many of them, I only comment the method in the superclass (I avoid copying the comment to the implementations in subclasses because changing it later is harder, better keep things in one place).</div><div dir="auto">And finally finally, someone in other project was recently talking about “four types of documentation” and posted this link where the idea is explained, I thought you might find it interesting too: <a href="https://docs.divio.com/documentation-system/">https://docs.divio.com/documentation-system/</a></div><div dir="auto"><br></div><div dir="auto">Cheers,</div><div dir="auto">Luciano</div><div><br><div class="gmail_quote gmail_quote_container"><div dir="ltr" class="gmail_attr">On Tue, Apr 1, 2025 at 00:15 Hilaire Fernandes via Cuis-dev <<a href="mailto:cuis-dev@lists.cuis.st">cuis-dev@lists.cuis.st</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;padding-left:1ex;border-left-color:rgb(204,204,204)"><u></u>

  
    
  
  <div text="#000000" bgcolor="#FFFFFF">
    <p><font size="4" style="color:rgb(0,0,0)">For this Wednesday we can make a test drive.</font></p>
    <p><font size="4" style="color:rgb(0,0,0)">Naive idea:<br>
      </font></p>
    <p><font size="4" style="color:rgb(0,0,0)">- we pickup a class or hierarchy we want to
        improve the understanding with comments, code examples,...<br>
      </font></p>
    <p><font size="4" style="color:rgb(0,0,0)">- One will share its screen with the latest
        Cuis-Smalltalk-dev image, this person will be the editor.
        Suggestion: should be a native English writer<br>
      </font></p>
    <p><font size="4" style="color:rgb(0,0,0)">- I can still video record the experience<br>
      </font></p>
    <p><font size="4" style="color:rgb(0,0,0)">Advice on the set up ?<br>
      </font></p>
    <p><font size="4" style="color:rgb(0,0,0)">Opinion on class to work on?</font></p></div><div text="#000000" bgcolor="#FFFFFF"><p><font size="4" style="color:rgb(0,0,0)"><br>
      </font></p>
    <pre cols="72" style="font-family:monospace">-- 
<a href="http://mamot.fr/@drgeo" target="_blank" style="font-family:monospace">http://mamot.fr/@drgeo</a></pre>
  </div>

-- <br>
Cuis-dev mailing list<br>
<a href="mailto:Cuis-dev@lists.cuis.st" target="_blank">Cuis-dev@lists.cuis.st</a><br>
<a href="https://lists.cuis.st/mailman/listinfo/cuis-dev" rel="noreferrer" target="_blank">https://lists.cuis.st/mailman/listinfo/cuis-dev</a><br>
</blockquote></div></div>