We are building a new experience for our SmartBear Community.
This site is now read-only. You can still browse and search as usual. Learn More

Forum Discussion

mboyce's avatar
mboyce
Contributor
7 years ago
Solved

What are people doing for READMEs for their projects?

I'm wondering how everyone handles including some kind of README/instructions for their automation. As my suites grow, I think it would be helpful for there to be READMEs for the suite and each proje...
  • vthomeschoolmom's avatar
    vthomeschoolmom
    7 years ago

    We use confluence topics for this.

vthomeschoolmom's avatar
vthomeschoolmom
Super Contributor
7 years ago

We use confluence topics for this.

mboyce's avatar
mboyce
Contributor
7 years ago

Thanks! Do you provide a link somewhere in the TestComplete structure?

  • vthomeschoolmom's avatar
    vthomeschoolmom
    Super Contributor
    7 years ago

    No. The deciding factor for me is the target audience. The end goal would include who the material is for. I work for a company where we do the automation internally for our own products. So the target audience is my own internal team. Thus I communicate within the team structures. I would do otherwise if I were contracting out a project. 

    • mboyce's avatar
      mboyce
      Contributor
      7 years ago

      Yeah, that makes sense. Thanks for the response!