Re: design directory, ERM; was: Doxygen - is there a status?
Christian Stimming writes: > In this particular case: > - John said very clear that the "higher level" documentation used to be put > in > texinfo or doxygen and it didn't work, so we should put it in the wiki. > Nobody > from the core developers objected, so please take this as a decision and > continue to work on "higher level" design documentation only in the wiki. The > texinfo files should be deleted as soon as the last remaining useful bits are > copied into the wiki. > - The "lower level" i.e. the function-level documentation is in doxygen and > should stay there. > > In case I've misunderstood any of the previous discussion, feel free to > comment or propose alternative solutions. This is my view as well. * High level designs in the Wiki * Low level designs (implementation info) and API docs in doxygen. And there can be links between. > Regards, > > Christian -derek -- Derek Atkins, SB '93 MIT EE, SM '95 MIT Media Laboratory Member, MIT Student Information Processing Board (SIPB) URL: http://web.mit.edu/warlord/PP-ASEL-IA N1NWH warl...@mit.eduPGP key available ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: design directory, ERM; was: Doxygen - is there a status?
On Monday 15 September 2014 11:52:46 Derek Atkins wrote: > Christian Stimming writes: > > In this particular case: > > - John said very clear that the "higher level" documentation used to > > be put in texinfo or doxygen and it didn't work, so we should put > > it in the wiki. Nobody from the core developers objected, so please > > take this as a decision and continue to work on "higher level" > > design documentation only in the wiki. The texinfo files should be > > deleted as soon as the last remaining useful bits are copied into > > the wiki. > > - The "lower level" i.e. the function-level documentation is in > > doxygen and should stay there. > > > > In case I've misunderstood any of the previous discussion, feel free > > to comment or propose alternative solutions. > > This is my view as well. > > * High level designs in the Wiki > * Low level designs (implementation info) and API docs in doxygen. > > And there can be links between. Yes, looks good to me. Geert ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Wiki page for design documentation
Hi, following the advice I have created a Wiki page http://wiki.gnucash.org/wiki/Project_and_Design_Documentation Currently I feed it with what I found in doc/projects.html, so far I transferred the architectural design goals. How should the review procecess look like? Shall I notify you with every section that I think is "ready" (i.e. when I cannot update myself anymore without further help)? Kind regards, Carsten ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: Wiki page for design documentation
On Sep 15, 2014, at 11:49 AM, Carsten Rinke wrote: > Hi, > > following the advice I have created a Wiki page > http://wiki.gnucash.org/wiki/Project_and_Design_Documentation > > Currently I feed it with what I found in doc/projects.html, so far I > transferred the architectural design goals. > > How should the review procecess look like? > Shall I notify you with every section that I think is "ready" (i.e. when I > cannot update myself anymore without further help)? Thanks. I looked at it yesterday and it seems like a good start. Seeing support for OFX in “Looking Into the Future” really drives home how long that material has been ignored! What do you have in mind for the “Decisions” and “Rules” sections? You can report progress as often as you like. Wikis are collaborative, so rather than reviews others will just edit what you’ve written. We can discuss here, on the “talk” page associated with Project_and_Design_Documentation (Maybe we could shorten that to just “Project Design” or even just “Design”?), and on IRC as you prefer. Frank and I check the “Recent Changes” page frequently for spam suppression, so we’ll know about changes within a few hours of your making them, but I don’t know about others, so perhaps periodic updates here would be worthwhile as well. Regards, John Ralls ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Re: Wiki page for design documentation
Hi Carsten, Am 15.09.2014 um 21:10 schrieb John Ralls: > On Sep 15, 2014, at 11:49 AM, Carsten Rinke > wrote: > >> Hi, >> >> following the advice I have created a Wiki page >> http://wiki.gnucash.org/wiki/Project_and_Design_Documentation >> >> Currently I feed it with what I found in doc/projects.html, so far >> I transferred the architectural design goals. >> >> How should the review procecess look like? Shall I notify you with >> every section that I think is "ready" (i.e. when I cannot update >> myself anymore without further help)? > > Thanks. I looked at it yesterday and it seems like a good start. > Seeing support for OFX in “Looking Into the Future” really drives > home how long that material has been ignored! > > What do you have in mind for the “Decisions” and “Rules” sections? > > You can report progress as often as you like. Wikis are > collaborative, so rather than reviews others will just edit what > you’ve written. We can discuss here, on the “talk” page associated > with Project_and_Design_Documentation (Maybe we could shorten that to > just “Project Design” or even just “Design”?), and on IRC as you > prefer. Frank and I check the “Recent Changes” page frequently for > spam suppression, so we’ll know about changes within a few hours of > your making them, but I don’t know about others, so perhaps periodic > updates here would be worthwhile as well. > > Regards, John Ralls Yes, you are not unwatched there. ;-) Just a few notes: In most cases, I would link GnuCash to the wiki instead of the website, because it is easier to maintain and usually more recent. "Project Design” is long enough, if nobody has a better word for "Project" here - "Design" alone could be interpreted "of website", "...GUI", For some parts of your index might be already more recent pages in the http://wiki.gnucash.org/wiki/GnuCash#Getting_involved_in_the_project section. Regards Frank ___ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
