Documentation Fragmentation


RE: Documentation Fragmentation
#8
(2020-05-21, 16:55)Orion Pobursky Wrote: Can you point me to these duplicates?

For colors you have:
https://www.ldraw.org/article/299.html (describing the language extension including color parameters)
https://www.ldraw.org/article/547.html (defining the colors themselves)

For the OMR:
https://www.ldraw.org/article/593.html (the guidelines for OMR-compliant models)
https://www.ldraw.org/documentation/ldra...itory.html (rules for the repository itself)

Quote:This is why things are broken up in the menus between "File Format" and "Official Library". I think that maybe everything under the "Official Heading" can be combined into one standalone document. As far as "File Format", those documents need to be separate since they outline the core spec and the various extensions.

Sure, and I recognize the reasoning for keeping the documents separate. That's what makes me think the ultimate solution isn't so much to move the existing documents (though some reorganization may be a good idea), but rather an additional resources that compiles all the different information into one place, organized by topic and in some kind of logical sequence. It could either contain the actual specs in-line, or hyperlink to the individual articles where they stand.

Quote:This what I want. Perspective from someone just starting out. Be bold with your suggestions. If you want, make a visual mock-up of how things should look. I suck at creating UI from whole cloth but if you give me a visual template, I can replicate.

I'll put some thought to it, as time permits. Best way to start might be just coming up with an outline form, whether it's for a centralized documentation web page, or something separate like a manual or "bible".
Reply
« Next Oldest | Next Newest »



Messages In This Thread
RE: Documentation Fragmentation - by N. W. Perry - 2020-05-22, 15:20

Forum Jump:


Users browsing this thread: 2 Guest(s)