<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii">
<META NAME="Generator" CONTENT="MS Exchange Server version 5.5.2658.2">
<TITLE>RE: Python doc experiment</TITLE>
</HEAD>
<BODY>
<P><FONT SIZE=2>[A.M. Kuchling]</FONT>
</P>
<P><FONT SIZE=2>#- As a half-hour hack, I took a copy of the Python docs, stuck </FONT>
<BR><FONT SIZE=2>#- them in a</FONT>
<BR><FONT SIZE=2>#- frameset, and added some JavaScript that displays a </FONT>
<BR><FONT SIZE=2>#- corresponding Wiki page</FONT>
<BR><FONT SIZE=2>#- in another frame. Feel free to play with </FONT>
<BR><FONT SIZE=2>#- <A HREF="http://pydoc.amk.ca/frame.html;" TARGET="_blank">http://pydoc.amk.ca/frame.html;</A></FONT>
<BR><FONT SIZE=2>#- please record problems on the Wiki page at</FONT>
<BR><FONT SIZE=2>#- <A HREF="http://pydoc.amk.ca/w/KnownProblems" TARGET="_blank">http://pydoc.amk.ca/w/KnownProblems</A> .</FONT>
</P>
<P><FONT SIZE=2>Interesting experiment. I certainly appreciate your work.</FONT>
</P>
<P><FONT SIZE=2>And I think here is the place to comment this:</FONT>
</P>
<P><FONT SIZE=2>I find *very* useful the way that MySQL handles this. It shows the standard text for the item (the same text that the PDF) and lets the user to add comments (not to edit the other text). You can see one example at <A HREF="http://dev.mysql.com/doc/mysql/en/Insert_speed.html" TARGET="_blank">http://dev.mysql.com/doc/mysql/en/Insert_speed.html</A>.</FONT></P>
<P><FONT SIZE=2>This way, user experience can be added to each item. More, this can be useful to the responsible of that doc to get important feedback, and maybe in later versions he/she can get this feedback *into* the std docs, or fix bugs in the docs, etc.</FONT></P>
<P><FONT SIZE=2>. Facundo</FONT>
</P>
</BODY>
</HTML>