On 05/05/15 23:55, Jordan Justen wrote:
> On 2015-05-05 13:20:59, Kinney, Michael D wrote:
>> My main point about the spec is that both need to be updated if this
>> concept is accepted. Not that one has to be done before the other.
> 
> Ok. I'll look into the changes you recommended for the code.
> 
> Regarding the specs, it is too bad that they aren't managed in source
> control so anyone might be able to recommend patches to them. I can't
> imagine what challenges there might be in getting to that point
> though. :)

I can. :)

The only way this would ever work (in a distributed development
scenario) if the master document were maintained in a plaintext based
markup language, as in: source code. Then it could be formatted as HTML,
PDF etc, and people could clone the repo and send patches for the
document source. Example:

https://lists.oasis-open.org/archives/virtio/201504/threads.html
https://lists.oasis-open.org/archives/virtio-comment/201503/threads.html

Seeing how the "Creator" metadata field of
"UNI_File_Spec_v1_2_Errata_A.pdf" says "Acrobat PDFMaker 11 for Word",
the first step would be to rewrite the master Word document in whatever
markup language was chosen.

Generally speaking, doing this for documentation is much harder than
doing it for source code that is compiled to executables. The latter is
primarily worked on by programmers for who version control is an
everyday tool. Whereas documentation tends to belong to technical
writers primarily, who tend to be much less used to plaintext editing,
source control, and sending / reviewing patches. (Of course if engineers
participate in writing the documentation, or else the tech writers are
themselves engineers, that's ideal.)

WYSIWYG suites tend to support "change tracking", "change proposals &
acceptance", and "collaborative editing" these days, but everything I've
seen thus far in this area is extraordinarily limited compared to git
and mailing list based workflow.

Thanks
Laszlo

> Thanks for your time on the code review,
> 
> -Jordan


------------------------------------------------------------------------------
One dashboard for servers and applications across Physical-Virtual-Cloud 
Widest out-of-the-box monitoring support with 50+ applications
Performance metrics, stats and reports that give you Actionable Insights
Deep dive visibility with transaction tracing using APM Insight.
http://ad.doubleclick.net/ddm/clk/290420510;117567292;y
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/edk2-devel

Reply via email to