Skip to main content

Content Management for Oracle Database Developers - what do you need?

Yes, yes, I know: another post with little or nothing to do with PL/SQL. My apologies. But remember, I do offer
So please don't say "But what have you done for me lately?" :-)

'Cause then I would feel bad that this post is about me asking you for something.

I am involved here at Oracle with both content generation (see above) and working on community-oriented apps that make it easier for you to access expertise and resources on Oracle Database developer-related topics, including:
As many of you are probably aware, content is great stuff ("Content is King"), but and especially for technology-related content, it can get "stale" - what is accurate today is misleading tomorrow; what is good advice today is a dead end tomorrow. 

In addition, you need to have really good metadata about your content to make it easy for users to find what they need quickly (you say "Google", I say "Well, maybe, sometimes that's good enough...").

So I am working on a project to strengthen our content metadata and (eventually) engage our community to help us ensure that resources available to that community are as accurate and useful as possible.

To that end, I thought I would ask you
  • What metadata should we keep track of?
  • What features could we, should we add to our community content applications/sites to improve their quality?
Current Ideas on Content Metadata
  • Author: who produced the content
  • URL of content
  • Related to which product(s)?
  • Which specific feature(s) within a product?
  • Minimum version to which it applies
  • Maximum version after which it no longer applies
  • Expertise level (beginner, intermediate, advanced)
  • Link to product documentation
What else can you think of?

Additional Features?

What features could we, should we add to our community content applications/sites to improve their quality?

Thanks in advance for any spare brain cells you devote to this!

Steven

Comments

  1. Just a few more ideas for content metadata:
    1) estimated time required to read/listen/make-practice
    2) rating system (e.g. 1-5 stars)
    Cheers
    A.

    ReplyDelete
  2. Thinking of Oracle online documentation:
    - a link to the same information but for the current version (or all versions)

    ReplyDelete
  3. @A, yes great points, thanks!
    @Sabine: yes, multiple versions are important.

    ReplyDelete
  4. Perhaps categorizing content in terms of things like "Performance", "Style Guide", "Instrumentation", "Change of Behaviour" (e.g. NO_DATA_NEEDED and how it's treated differently between 11.2.0.3 and 11.2.0.4),... I know, you might need an Ontology expert to put all these and similar phrases under one "category" but I believe having such metadata would help.

    ReplyDelete
  5. Thanks, Babak. These categorizations are critical - and tough to get right. I like your "Change of Behavior" idea.

    ReplyDelete
  6. To be honest, I think the makers of StackOverflow have the right idea here: making sure that all content is Google-friendly is the most scaleable way of ensuring content is easily discoverable.

    ReplyDelete
  7. Great point, Jeff, and a non-trivial issue in the world of APEX, from what I understand.

    ReplyDelete
  8. I would step back from the idea of Oracle content to that of a content repository. There's a decent Java spec https://jcp.org/aboutJava/communityprocess/final/jsr170/index.html. Things to consider include: content-type/mime-type, namespace, versioning, full-text search, hierarchical (directory-like) storage, hierarchical search (xpath?), fine-grained access, authorship and collaboration, listening-to/observation-of content with change notification.

    I don't mean to include everything in version 1.0 (or 0.3?), but rather to aim for a general-purpose content repository, implementing relevant features as needed/useful.

    ReplyDelete

Post a Comment

Popular posts from this blog

Quick Guide to User-Defined Types in Oracle PL/SQL

A Twitter follower recently asked for more information on user-defined types in the PL/SQL language, and I figured the best way to answer is to offer up this blog post. PL/SQL is a strongly-typed language . Before you can work with a variable or constant, it must be declared with a type (yes, PL/SQL also supports lots of implicit conversions from one type to another, but still, everything must be declared with a type). PL/SQL offers a wide array of pre-defined data types , both in the language natively (such as VARCHAR2, PLS_INTEGER, BOOLEAN, etc.) and in a variety of supplied packages (e.g., the NUMBER_TABLE collection type in the DBMS_SQL package). Data types in PL/SQL can be scalars, such as strings and numbers, or composite (consisting of one or more scalars), such as record types, collection types and object types. You can't really declare your own "user-defined" scalars, though you can define subtypes  from those scalars, which can be very helpful from the p...

Three tips for getting started right with Oracle Database development

By "Oracle Database development", I mean, more or less, writing SQL and PL/SQL. I assume in this post that you have access to Oracle Database (which you can get via Cloud services, Docker , GitHub and OTN ). A. Use a powerful IDE, designed with database programming in mind. There are lots of editors out there, and many IDEs that work with Oracle Database. Sure, you could use Notepad, but OMG the productivity loss. You could also use a popular editor like Sublime, and then it get it working with Oracle. I suggest, however, that you  download  and install Oracle's own own, free, powerful IDE: SQL Developer . If you like to complement your graphical IDE with a command line tool (or OMG if you actually prefer  a command line tool to a graphical interface), you should also check out the relatively new and generating-lots-of-excitement SQLcl . B. Enable compile-time warnings and PL/Scope. The database has tons of useful functionality burned right into it, ready for...

Why DBMS_OUTPUT.PUT_LINE should not be in your application code

A database developer recently came across my  Bulletproof PL/SQL  presentation, which includes this slide. That first item in the list caught his attention: Never put calls to DBMS_OUTPUT.PUT_LINE in your application code. So he sent me an email asking why I would say that. Well, I suppose that is the problem with publishing slide decks. All the explanatory verbiage is missing. I suppose maybe I should do a video. :-) But in the meantime, allow me to explain. First, what does DBMS_OUTPUT.PUT_LINE do? It writes text out to a buffer, and when your current PL/SQL block terminates, the buffer is displayed on your screen. [Note: there can be more to it than that. For example, you could in your own code call DBMS_OUTPUT.GET_LINE(S) to get the contents of the buffer and do something with it, but I will keep things simple right now.] Second, if I am telling you not to use this built-in, how could text from your program be displayed on your screen? Not without a lot o...