Docs/reports infrastructure

[info-rchitect]

Hi,

I am working on an initial reports module that would allow engineering docs to be created in a collaborative manner. Take a characterization report, someone would own scan, someone BIST, etc. My question is where should this code live? Should there be an Origen::Docs module or Origen::Reports module down lib? I was thinking users would create a sub-dir per report they are working on and within that sub-dir all files (intro, section1, section2, etc.) that make up the report/doc would live. Or should these files live in their own top level directory outside of and parallel to lib?

thx

[welguisz]

@info-rchitect ... The question is how standard are these reports and can their reuse potential. Are they reusable from SoC to SoC? From Company to Company? For example, I have been working on extending the Origen API in individual gems which could be reused from SoC and customizable between companies.

At some point, I will make parts of these individual gems open-sourced.

• OrigenSpectacular ::: Gem for generating Specification resources (e.g. Spec Tables in Data Sheets)
• OrigenPinnacle ::: Gem for generating Pin resources (e.g. Pin Table, OrCad)
• OrigenHamilton ::: Revision History and Diffing Tool
• OrigenElixerr ::: Errata Reporting
• OrigenRegalia ::: Registers
• OrigenExtra ::: Other Items
• OrigenSphere ::: Capsulates the above gems

Inside a company, the could extend the gems to their work, e.g. NXP could extend OrigenPinnacle to include SVG drawings and call it OrigenPinnacleNXP.

I think that we need to meet next week in person and do a little show and tell and figure how to make OrigenSphere possible.

[ginty]

Should be a plugin, Origen core should be concerned only about DUT modelling and general runtime infrastructure. Specific view generation like this should be handled by plugins.

[info-rchitect]

@welguisz i knew you had been busy! Yeah let's meet and do exactly what you described. But to answer your questions:

• yes this module is meant to be product and company agnostic
  • it is meant to go directly from the DUT model to a PDF document (though it could be expanded to other formats over time).
  • i would use it as a product engineer to help make characterization reports but I hope it is usable enough to get Designers to ditch expensive, closed systems like Framemaker. I know some companies use the DITA publishing and that is fine. This is meant to handle all of the docs that don't use that sort of system.

Here is an example of a specs table I created using the prawn gem and the current origen specs model.

@ginty I agree it should be a plugin but where would those plugin source files live? I don't mean the plugin source but the user source files that write to create reports?