wiki:Documentation/Outdated

The following pages may need an update:

Page Task / Problem Owner
Documentation/Howto/OptimizeExternalApplications update after #2521 problem refactoring abeham
Documentation/Howto/UseHiveForOptimization mentions HL 3.3.6 - any updates?
Documentation/Howto/SetupHiveSlave Should include a download link. Describe new installer
Documentation/DevelopmentCenter/ExternalLibraries mentions 3.3.10, updates? jkarder
Documentation/DevelopmentCenter/VSCodeSnippets update to current vs version
Documentation/DevelopmentCenter/ImplementAnEvaluator no changes required
Documentation/DevelopmentCenter/UsePersistence update to HEAL.Attic

Discussion

  • Documentation should be less of a loose collection of individual articles with an example here and an example there
    • Concrete examples are great though, definitely keep them
  • We should add some structure, by defining use cases and supporting those with specific documentation
    • Like "This is how you do XYZ", for all the XYZ that we can think of and then have concrete examples for XYZ
  • We need short(!) reference documentation on common topics like parameters and parameter lookup, backwards compatibility, cloning, operator instrumentation, etc.
Last modified 2 years ago Last modified on 08/14/20 16:29:55