W3C home > Mailing lists > Public > public-aikr@w3.org > May 2020

Software documentation conventions/open standard (note work to be done)

From: carl mattocks <carlmattocks@gmail.com>
Date: Wed, 27 May 2020 09:45:22 -0400
Message-ID: <CAHtonunUnFkS5QQp3DuvByqdX0g3rksNQ_h_TvRk3rDtZ-h+3A@mail.gmail.com>
To: W3C AIKR CG <public-aikr@w3.org>
Paola

Would you accept that an AI Strategist plan for an AI System  crafted
/published, via StratML, would be a good use of an open standard for
documentation?

Carl


It was a pleasure to clarify


On Mon, May 25, 2020 at 10:11 PM Paola Di Maio <paola.dimaio@gmail.com>
wrote:

> Thanks for starting to share snippets of ideas and code, such as krid and
> parser for stratml
>
> //I come from a systems documentation background - I teach a course as I
> learned the
> trade from an emeritus :-)//
>
> May I remind the list that it is good practice to document and share work
> being done in ways
> that it can be intelligible . (should say what it is, how to use it etc)
>
> (If something cannot be understood or does not make any sense because it
> is incomplete
> or truncated or devoided of context, could be ignored or generate
> revulsion)
>
> I note the lack of open standards for software documentation as a possible
> to be done/long term deliverable
> for this or other CGs (work to be done?)
> If someone knows of an open standards for software documentation, please
> share it here!
>
> Here some pointers,
>
> 1. Good practices in documenting software/code
>
> https://blog.prototypr.io/software-documentation-types-and-best-practices-1726ca595c7f
>
>
> 2. Good example of adoption of good practice Open Stack
> https://docs.openstack.org <https://docs.openstack.org/ussuri/>
>
> Please consider sharing ideas and software in a way that it can be
> understood and used
> by others on the list, thanks!!
>
> pdm
>
>
>
>
Received on Wednesday, 27 May 2020 13:46:12 UTC

This archive was generated by hypermail 2.4.0 : Wednesday, 27 May 2020 13:46:12 UTC