Date   

Re: Job Search: Need advice on finding DITA jobs. #jobhunting

danlittman
 

Thanks for the suggestions, everyone. I am on the board of my local STC chapter (San Francisco Bay Chapter), which reminds me: We're still having meetings and events, all on Zoom, and they're free and open to anyone interested. We have a weekly happy hour that has turned out to be more successful than any of us expected. At our general meeting earlier this month we heard from a labor lawyer about AB5 (the California "gig worker" law that Uber and Lyft are planning to spend $150 million to overturn in a ballot initiative). On September 9, if all goes as planned, we'll be hearing from an expert on writing for translation and localization. To participate in any of those events, find info on our web site, which is still flying under the old URL, https://www.stc-berkeley.org/. (Ignore the button for buying tickets--the virtual meetings are free.)    Best,  --Dan Littman


Re: Job Search: Need advice on finding DITA jobs. #jobhunting

nkerzreho
 

Hi Dan,

I find that joining a community or society for writers helps (I'm aware of STC for USA, Tekom in Europe, ISTC in UK...). They usually have job boards.

If you can, you may want to participate in an event as an attendee or a presenter.
Presenting at industry events means you have a free ticket and is a great way to present your skills.

Good events will also provide you with a large number of topics that are related to technical communication, opportunities to discuss with others, including potential employers, and join a job discussion too.

The next online event that I'm participating in is called ConVEx, and is hosted by CIDM.
https://convex.infomanagementcenter.com/chat-presentations/
 
Hope some of these tips will help and good luck for your job hunt,
Nolwenn


Re: keyref and conkeyref best practice and processing flow

DANIEL ESSIET
 

Please, l am business journalist trying to transit to technical writing. Where should l start from? I hold a BA Mass Communications and a PGD BA. I have passed a few Google digital certification.
Please advise me.
Kind regards,
Daniel Essiet
Lagos

On Tue, Aug 25, 2020, 11:38 PM Dan Vint <dvint@...> wrote:
Thanks for the pointer. I hadn't paid attention to how our ccms created the system generated keys were defined. It turns out they use local. I'm asking them why as even without this issue, resource-only seems to be the correct choice.



Sent from my Verizon, Samsung Galaxy smartphone


-------- Original message --------
From: Radu Coravu <radu_coravu@...>
Date: 8/23/20 10:47 PM (GMT-08:00)
Subject: Re: [dita-users] keyref and conkeyref best practice and processing flow

Hi Dan,

This should work. Please make sure that the topic inside which that
reused <p> element is located is referenced in the DITA Map as a
topicref with the "processing-role='resource-only'" attribute set on it:

https://github.com/dita-ot/dita-ot/issues/3546

If that did not help maybe you can give us more details like:

1) The DITA OT version you are using.

2) The output format you are publishing to.

3) Attach a small sample DITA project exemplifying the problem.

Regards,
Radu

Radu Coravu
Oxygen XML Editor

On 8/21/20 7:57 PM, Dan Vint wrote:
> I've been googling around for information on using keyref and
> conkeyref and not finding confirmation for something I thought I saw.
>
> I believe there is a recommendation (maybe requirement) that you can't
> nest these proceses. My testing seems to say it isn't supported, but
> maybe there is a feature I've not setup properly.
>
> We are trying to build a para that will be keyconref'd into a variety
> of locations. In this para we are also trying to use variables for the
> product names that are defined with keys.
>
> I've done the following:
> - confirmed that copying the para into the referencing topic allows
> the product name variable to work - so that key is configured properly
> - conkeyrefing the para in, the product variable is not resolved. I
> don't even get a message in the OT log that indicates it is being seen.
>
> I'm torn between saying this is a useful feature to have if it isn't
> supported, but on the other hand I can see where it might cause an
> infinite loop if these are allowed to nest.
>
> I'm mainly just trying to confirm that this is the way it is and that
> I haven't missed something.
>
> thanks
> ..dan
>
>
>





Re: Dita to Confluence #content-delivery

Radu Coravu
 

Hi Carole,

I found that what worked best for me was to publish DITA to Word and then import the Word to confluence:

https://blog.oxygenxml.com/topics/dita_to_confluence.html

Regards,
Radu
Radu Coravu
Oxygen XML Editor
On 8/25/20 8:05 PM, carole.c.girard@... wrote:

Has anyone managed to link and properly display a dita file directly from bitbucket to Confluence?

All our source files for our documentation are in Dita , stored on a repository in bitbucket.
I did try several plugins ( bitbucket url ,HTML from bob swift (XML).  markdown plugin, etc. , with partial success. Either tables or images are not displayed properly or at all.

Has anyone managed to push dita files directly to Confluence using the HTML from Bob swift plugin that  transforms xml via an xslt to Confluence?

I did find the dita2 confluence plugin , but since it is no longer supported I am reluctant to use it.

kind regards


  


Re: keyref and conkeyref best practice and processing flow

Dan Vint
 

Thanks for the pointer. I hadn't paid attention to how our ccms created the system generated keys were defined. It turns out they use local. I'm asking them why as even without this issue, resource-only seems to be the correct choice.



Sent from my Verizon, Samsung Galaxy smartphone


-------- Original message --------
From: Radu Coravu <radu_coravu@...>
Date: 8/23/20 10:47 PM (GMT-08:00)
To: main@dita-users.groups.io, dita-users@groups.io
Subject: Re: [dita-users] keyref and conkeyref best practice and processing flow

Hi Dan,

This should work. Please make sure that the topic inside which that
reused <p> element is located is referenced in the DITA Map as a
topicref with the "processing-role='resource-only'" attribute set on it:

https://github.com/dita-ot/dita-ot/issues/3546

If that did not help maybe you can give us more details like:

1) The DITA OT version you are using.

2) The output format you are publishing to.

3) Attach a small sample DITA project exemplifying the problem.

Regards,
Radu

Radu Coravu
Oxygen XML Editor

On 8/21/20 7:57 PM, Dan Vint wrote:
> I've been googling around for information on using keyref and
> conkeyref and not finding confirmation for something I thought I saw.
>
> I believe there is a recommendation (maybe requirement) that you can't
> nest these proceses. My testing seems to say it isn't supported, but
> maybe there is a feature I've not setup properly.
>
> We are trying to build a para that will be keyconref'd into a variety
> of locations. In this para we are also trying to use variables for the
> product names that are defined with keys.
>
> I've done the following:
> - confirmed that copying the para into the referencing topic allows
> the product name variable to work - so that key is configured properly
> - conkeyrefing the para in, the product variable is not resolved. I
> don't even get a message in the OT log that indicates it is being seen.
>
> I'm torn between saying this is a useful feature to have if it isn't
> supported, but on the other hand I can see where it might cause an
> infinite loop if these are allowed to nest.
>
> I'm mainly just trying to confirm that this is the way it is and that
> I haven't missed something.
>
> thanks
> ..dan
>
>
>





Re: #reuse Deeper Nesting vs. Limiting Nesting of Maps #reuse

 

I have attached a much-slimmed-down version of the ditamap referenced previously.


#reuse Deeper Nesting vs. Limiting Nesting of Maps #reuse

 

Hello All,

I require some best-practice guidance regarding the subject of map nesting.

I have a <bookmap> that references <chapters> that are <map>s.  These chapter sub-maps then define a hierarchy of <topicref>s.  This is where my map-nesting currently stops.

At most, these sub-maps contain 18 <topicref>s at the highest hierarchical level; at least, only one.  They tend to average six or less as a whole.

When defining the upper levels of the hierarchies, I have been following the best practice of avoiding the use of <topichead>s in favor of stub or summary topics containing only a title.  At the third level of nesting, I finally reference the more 'meaty' content.

Example: (see attached Forowners.ditamap)

Note: Please ignore the sourceTag and sourceAttrs attributes - they are only there for analysis purposes temporarily.

Questions:

(1) How deep, in general, is it a best practice to go in terms of nesting maps?  The examples I have been exposed to, whether on the web or within projects, usually stop nesting after the chapter level, then adopt the approach I took. 
(2) Might it be advisable, given the number of topics referenced once I get down to the meat of the content, to go further, with chapters referencing sub-chapter maps?  Dare I go beyond that?
(3) Correct me if I'm wrong, but, regarding stub/summary topics, is one reason behind employing such a practice that it better facilitates isolation of heading text for translation and reuse purposes?

Thoughts:

There is an appeal to 'map-ifying' as much as possible, yet I do not like having content as a flat structure, so that would mean chapter folders with sub-chapter folders with possibly other nested folders.  That's one implication for me.  On the other hand, I do not care for the clutter that my present chapter maps have.

Thank You in Advance,

-Tony Bufort
 AJB Consulting


Dita to Confluence #content-delivery

carole.c.girard@...
 

Has anyone managed to link and properly display a dita file directly from bitbucket to Confluence?

All our source files for our documentation are in Dita , stored on a repository in bitbucket.
I did try several plugins ( bitbucket url ,HTML from bob swift (XML).  markdown plugin, etc. , with partial success. Either tables or images are not displayed properly or at all.

Has anyone managed to push dita files directly to Confluence using the HTML from Bob swift plugin that  transforms xml via an xslt to Confluence?

I did find the dita2 confluence plugin , but since it is no longer supported I am reluctant to use it.

kind regards


Re: keyref and conkeyref best practice and processing flow

Julio J Vazquez
 

If you're new to this, I suggest you purchase at least one of the books about the subject to avoid trying to assemble knowledge from disparate questions. Depending on what you want to learn, there are plenty of resources to help you. 

Julio J. Vazquez


Re: keyref and conkeyref best practice and processing flow

DANIEL ESSIET
 

I am new to this. I am going to learn from the scratch. Presently, l work as a business journalist with The Nation Newspaper, Lagos.
Regards,
Daniel Essiet

On Mon, Aug 24, 2020, 6:47 AM Radu Coravu <radu_coravu@...> wrote:
Hi Dan,

This should work. Please make sure that the topic inside which that
reused <p> element is located is referenced in the DITA Map as a
topicref with the "processing-role='resource-only'" attribute set on it:

https://github.com/dita-ot/dita-ot/issues/3546

If that did not help maybe you can give us more details like:

1) The DITA OT version you are using.

2) The output format you are publishing to.

3) Attach a small sample DITA project exemplifying the problem.

Regards,
Radu

Radu Coravu
Oxygen XML Editor

On 8/21/20 7:57 PM, Dan Vint wrote:
> I've been googling around for information on using keyref and
> conkeyref and not finding confirmation for something I thought I saw.
>
> I believe there is a recommendation (maybe requirement) that you can't
> nest these proceses. My testing seems to say it isn't supported, but
> maybe there is a feature I've not setup properly.
>
> We are trying to build a para that will be keyconref'd into a variety
> of locations. In this para we are also trying to use variables for the
> product names that are defined with keys.
>
> I've done the following:
> - confirmed that copying the para into the referencing topic allows
> the product name variable to work - so that key is configured properly
> - conkeyrefing the para in, the product variable is not resolved. I
> don't even get a message in the OT log that indicates it is being seen.
>
> I'm torn between saying this is a useful feature to have if it isn't
> supported, but on the other hand I can see where it might cause an
> infinite loop if these are allowed to nest.
>
> I'm mainly just trying to confirm that this is the way it is and that
> I haven't missed something.
>
> thanks
> ..dan
>
>
>





Re: Getting Started with Chatbots - Tips? #content-delivery #next-generation

Wim Hooghwinkel
 

Hi Marcus,

it’s all about metadata (also referred to as taxonomy).  This may help: Making Your Chatbot Scalable and Knowledgeable .

Contact me off list if you need any help.


Vriendelijke groet / Kind regards,
 
Wim Hooghwinkel


Getting Started with Chatbots - Tips? #content-delivery #next-generation

marcus.schmidt@...
 

Hello,
 
I've been playing around with Microsoft Bot Framework recently.
 
While it works fine with HTTP requests to all kinds of APIs I'm not really sure yet how I would "feed" or train it with DITA content.
 
So what I basically want to set up is a bot that answers questions about using our products based on the DITA content in our online help files.
 
Do you have any tips or links on this topic that could help me getting started?
Maybe there is also a better solution for this than MS Bot Framework?
 
Best Regards
Marcus


Re: Images and keywords: When is keyref a better option than conkeyref? #conref #keys

@l3arn4life
 

Good morning Jonathan,

it seems to me that having reusable images in a dedicated warehouse-topic is easier to manage than keydefs in a map: create a table with two columns where the left column holds your images and the right column displays the assigned image-ID and holds additional comments for context, if needed. Reference with conkeyref.
Keyrefs, on the other hand, seem to be well suited for what I like to call "content swapping": multiple keyscopes contain the same key with different hrefs, content is "swapped" depending on the keyscope. This is useful for cases where entire topics or parts of a topic are reused but the image needs to be different in each instance (this method, of course, is not restricted to images). Beware though: if you decide to use keyscopes, you’ll not be able to properly use reltables alongside with the current DITA-OT (3.5.2).

Regards,
Ed


Re: keyref and conkeyref best practice and processing flow

Radu Coravu
 

Hi Dan,

This should work. Please make sure that the topic inside which that reused <p> element is located is referenced in the DITA Map as a topicref with the "processing-role='resource-only'" attribute set on it:

https://github.com/dita-ot/dita-ot/issues/3546

If that did not help maybe you can give us more details like:

1) The DITA OT version you are using.

2) The output format you are publishing to.

3) Attach a small sample DITA project exemplifying the problem.

Regards,
Radu

Radu Coravu
Oxygen XML Editor

On 8/21/20 7:57 PM, Dan Vint wrote:
I've been googling around for information on using keyref and conkeyref and not finding confirmation for something I thought I saw.

I believe there is a recommendation (maybe requirement) that you can't nest these proceses. My testing seems to say it isn't supported, but maybe there is a feature I've not setup properly.

We are trying to build a para that will be keyconref'd into a variety of locations. In this para we are also trying to use variables for the product names that are defined with keys.

I've done the following:
- confirmed that copying the para into the referencing topic allows the product name variable to work - so that key is configured properly
- conkeyrefing the para in, the product variable is not resolved. I don't even get a message in the OT log that indicates it is being seen.

I'm torn between saying this is a useful feature to have if it isn't supported, but on the other hand I can see where it might cause an infinite loop if these are allowed to nest.

I'm mainly just trying to confirm that this is the way it is and that I haven't missed something.

thanks
..dan


Re: Job Search: Need advice on finding DITA jobs. #jobhunting

Radu Coravu
 

Hi,

There is also the Write the Docs Slack community which has a job postings channel:

https://www.writethedocs.org/slack/

It is not DITA oriented but it does have a DITA channel and it's a very good place where to interact with other writers.

Regards,
Radu
Radu Coravu
Oxygen XML Editor
On 8/24/20 1:29 AM, Kristen James Eberlein wrote:

Hi, Dan.

Welcome to the list! It's meant for a broad audience: technical writers and end users of DITA, diehard DITA geeks who write specializations in their sleep, the DITA curious, and more.

I am not aware of other DITA lists with an employer/job-seeker focus, alas.

What you can do is set up alerts on both LinkedIn and Indeed which will send you e-mail when there are jobs posted with a DITA focus. There usually are a few new technical writer with DITA experience wanted ads most every day. Applying for these jobs will have a decent chance of getting your resume in front of a recruiter who knows "what DITA is and why it matters to their client."

I also can (and will) add a "jobhunting" hashtag to the dita-users site.

Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
OASIS Distinguished Contributor
Principal consultant, Eberlein Consulting LLC
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)

On 8/23/2020 5:08 PM, danlittman via groups.io wrote:
Hi all. I've been reading this board for a while but staying quiet because I'm sort of awed by you DITA experts setting up specializations, writing DTDs and schemas, etc. But I'm in the same boat as Westley W.'s team and have been wanting to ask about job-seeking ideas. I've worked in a DITA environment as a tech-writer, pulling material from unstructured Frame and creating DITA topics, setting up bookmaps, creating conrefs, applying conditionalizations, and so on. In short, I'm a tech-writer, an end-user, not a coder or sysadmin. I'm finding LinkedIn and Indeed overrun by recruiters who don't know what DITA is or why it matters to their clients. Is there a better way to get my name in front of potential employers? Are there organizations or DITA discussion boards similar to this but with more of an employer/job-seeker focus? Much obliged for any thoughts on this.
            Thanks.    --Dan Littman


  


Images and keywords: When is keyref a better option than conkeyref? #conref #keys

Jonathan Hanna
 

Hi all,

I'm starting to explore the use of keys in my content, specifically for images and keywords. I see advantages for using conkeyref instead of keyref such as:
  • the attributes of the element (e.g. @outputclass or @props) being passed along with the content
  • the ability to use elements within the resued content (e.g. <sub> or<sup>)
Are there any scenarios where keyref would be more appropriate than conkeyref for images and keywords?

Thanks,
Jonathan


Re: Job Search: Need advice on finding DITA jobs. #jobhunting

Kristen James Eberlein
 

Hi, Dan.

Welcome to the list! It's meant for a broad audience: technical writers and end users of DITA, diehard DITA geeks who write specializations in their sleep, the DITA curious, and more.

I am not aware of other DITA lists with an employer/job-seeker focus, alas.

What you can do is set up alerts on both LinkedIn and Indeed which will send you e-mail when there are jobs posted with a DITA focus. There usually are a few new technical writer with DITA experience wanted ads most every day. Applying for these jobs will have a decent chance of getting your resume in front of a recruiter who knows "what DITA is and why it matters to their client."

I also can (and will) add a "jobhunting" hashtag to the dita-users site.

Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
OASIS Distinguished Contributor
Principal consultant, Eberlein Consulting LLC
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)

On 8/23/2020 5:08 PM, danlittman via groups.io wrote:
Hi all. I've been reading this board for a while but staying quiet because I'm sort of awed by you DITA experts setting up specializations, writing DTDs and schemas, etc. But I'm in the same boat as Westley W.'s team and have been wanting to ask about job-seeking ideas. I've worked in a DITA environment as a tech-writer, pulling material from unstructured Frame and creating DITA topics, setting up bookmaps, creating conrefs, applying conditionalizations, and so on. In short, I'm a tech-writer, an end-user, not a coder or sysadmin. I'm finding LinkedIn and Indeed overrun by recruiters who don't know what DITA is or why it matters to their clients. Is there a better way to get my name in front of potential employers? Are there organizations or DITA discussion boards similar to this but with more of an employer/job-seeker focus? Much obliged for any thoughts on this.
            Thanks.    --Dan Littman


Re: Job Search: Need advice on finding DITA jobs. #jobhunting

danlittman
 

Hi all. I've been reading this board for a while but staying quiet because I'm sort of awed by you DITA experts setting up specializations, writing DTDs and schemas, etc. But I'm in the same boat as Westley W.'s team and have been wanting to ask about job-seeking ideas. I've worked in a DITA environment as a tech-writer, pulling material from unstructured Frame and creating DITA topics, setting up bookmaps, creating conrefs, applying conditionalizations, and so on. In short, I'm a tech-writer, an end-user, not a coder or sysadmin. I'm finding LinkedIn and Indeed overrun by recruiters who don't know what DITA is or why it matters to their clients. Is there a better way to get my name in front of potential employers? Are there organizations or DITA discussion boards similar to this but with more of an employer/job-seeker focus? Much obliged for any thoughts on this.
            Thanks.    --Dan Littman


Re: Job Search: Need advice on finding DITA jobs. #jobhunting

Kristen James Eberlein
 

Hi, Westley.

The other job board that I am aware of which frequently has postings for people with DITA skills is Indeed.

Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
OASIS Distinguished Contributor
Principal consultant, Eberlein Consulting LLC
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)


Re: Job Search: Need advice on finding DITA jobs. #jobhunting

Westley W.
 

On Fri, Aug 21, 2020 at 10:47 AM, Wayne Brissette wrote:
What might be helpful is knowing more about what converting content is. I guess I'm thinking more about what specific skills they have. XSL:FO? Java? that sort of thing. There are a lot of folks here on this list and often times I find it useful to know what skills people have in case we need people.

Great point.  I suppose the better description of them would be that they are the authors/technical writers, though the actual content is created in Word by an upstream team of SMEs. We have a pretty fixed process where they take the unstructured content (Word), put it into out content model, associate the files together via DITA maps, then run a preset transform.  They work primarily in Oxygen XML Author and Alfresco.    So they understand the DITA documentation stages but they wouldn't possess the skills to create or maintain a transform. 

I hope that helps better to describe their skills.  

 

501 - 520 of 46224