Looking for suggestions on documenting

classic Classic list List threaded Threaded
8 messages Options
ds
Reply | Threaded
Open this post in threaded view
|

Looking for suggestions on documenting

ds

I am interested in "best practices" suggestions on documenting my
projects.  My use of OpenSCAD initially is designing parts that I make
with manual machining equipment.  To that end, the closer I get to an
output that sort of looks like dimensioned drawings the happier I'll be.

I currently load up the top of any .scad files with a list of constants
and dimensions organized by part.  Printing this would give me
essentially a written list of dimensions.  I can also do a layouts from
a top view with lines.  However, I have not solved being able to put
text in the drawing, although I found an add-on project that apparently
can do that.

Because I am still in the enthusiastic but ignorant category of
knowledge of OpenSCAD, I am very interested in the perspectives of other
people already up to speed.

Thanks for any help you can give me.

Don
_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566
Reply | Threaded
Open this post in threaded view
|

Re: Looking for suggestions on documenting

Brant Merryman
Hi Don,

I currently do the same thing as you. I generally begin my .scad files with a comments section stating who created it, the name of the part, maybe a description of what the part is for, etc. Then I have a section where I define dimensions for the part. Then, I typically write modules for each logical portion of the part. And then at the end of the file, I call the top level module to produce the part.

If I'm using the same component in multiple parts, I usually put that in a separate file and include it in all the parts I'm using it in. The biggest downside to this is that then the files have to stay together or they won't compile, but that's a problem virtually every programming language has.

I love OpenSCAD :-)


On Thu, Mar 28, 2013 at 4:25 PM, ds <[hidden email]> wrote:

I am interested in "best practices" suggestions on documenting my
projects.  My use of OpenSCAD initially is designing parts that I make
with manual machining equipment.  To that end, the closer I get to an
output that sort of looks like dimensioned drawings the happier I'll be.

I currently load up the top of any .scad files with a list of constants
and dimensions organized by part.  Printing this would give me
essentially a written list of dimensions.  I can also do a layouts from
a top view with lines.  However, I have not solved being able to put
text in the drawing, although I found an add-on project that apparently
can do that.

Because I am still in the enthusiastic but ignorant category of
knowledge of OpenSCAD, I am very interested in the perspectives of other
people already up to speed.

Thanks for any help you can give me.

Don
_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566
ds
Reply | Threaded
Open this post in threaded view
|

Re: Looking for suggestions on documenting

ds
It does indeed sound like what I am doing.  The only thing that I am doing in addition to that is to have modules that represent assemblies of parts.  Then, those assemblies are positioned for the final item.  Each part is in a separate module to make it slightly easier to do multiple layouts, such as in example017.scad, which I found inspiring.

Thanks for your answer. It sounds like I am on the right track, although I will still see if I can implement text at some point.


On 03/28/13 15:25, Brant Merryman wrote:
Hi Don,

I currently do the same thing as you. I generally begin my .scad files with a comments section stating who created it, the name of the part, maybe a description of what the part is for, etc. Then I have a section where I define dimensions for the part. Then, I typically write modules for each logical portion of the part. And then at the end of the file, I call the top level module to produce the part.

If I'm using the same component in multiple parts, I usually put that in a separate file and include it in all the parts I'm using it in. The biggest downside to this is that then the files have to stay together or they won't compile, but that's a problem virtually every programming language has.

I love OpenSCAD :-)


On Thu, Mar 28, 2013 at 4:25 PM, ds <[hidden email]> wrote:

I am interested in "best practices" suggestions on documenting my
projects.  My use of OpenSCAD initially is designing parts that I make
with manual machining equipment.  To that end, the closer I get to an
output that sort of looks like dimensioned drawings the happier I'll be.

I currently load up the top of any .scad files with a list of constants
and dimensions organized by part.  Printing this would give me
essentially a written list of dimensions.  I can also do a layouts from
a top view with lines.  However, I have not solved being able to put
text in the drawing, although I found an add-on project that apparently
can do that.

Because I am still in the enthusiastic but ignorant category of
knowledge of OpenSCAD, I am very interested in the perspectives of other
people already up to speed.

Thanks for any help you can give me.

Don
_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566



_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566
Reply | Threaded
Open this post in threaded view
|

Re: Looking for suggestions on documenting

Bryan Bishop
In reply to this post by ds
On Thu, Mar 28, 2013 at 4:25 PM, ds <[hidden email]> wrote:
> I am interested in "best practices" suggestions on documenting my
> projects.  My use of OpenSCAD initially is designing parts that I make

How about something like this?

http://blog.reprap.org/2011/03/automatic-documentation-and-project.html

- Bryan
http://heybryan.org/
1 512 203 0507
_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566
ds
Reply | Threaded
Open this post in threaded view
|

Re: Looking for suggestions on documenting

ds
On 03/29/13 00:00, Bryan Bishop wrote:

> On Thu, Mar 28, 2013 at 4:25 PM, ds <[hidden email]> wrote:
>> I am interested in "best practices" suggestions on documenting my
>> projects.  My use of OpenSCAD initially is designing parts that I make
> How about something like this?
>
> http://blog.reprap.org/2011/03/automatic-documentation-and-project.html
>
> - Bryan
> http://heybryan.org/
> 1 512 203 0507
That looks interesting. Thanks for mentioning it.

Don
_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566
Reply | Threaded
Open this post in threaded view
|

Re: Looking for suggestions on documenting

Peter Falke
Hi,

I use minimagics to take dimensions off a stl when I need to. It is a free program you can get here:
http://software.materialise.com/minimagics

You can use it easily to make drawings of your stl file with dimensions and labels.

Hope it helps,

TakeItAndRun

On 29 March 2013 17:40, ds <[hidden email]> wrote:
On 03/29/13 00:00, Bryan Bishop wrote:
> On Thu, Mar 28, 2013 at 4:25 PM, ds <[hidden email]> wrote:
>> I am interested in "best practices" suggestions on documenting my
>> projects.  My use of OpenSCAD initially is designing parts that I make
> How about something like this?
>
> http://blog.reprap.org/2011/03/automatic-documentation-and-project.html
>
> - Bryan
> http://heybryan.org/
> <a href="tel:1%20512%20203%200507" value="+15122030507">1 512 203 0507
That looks interesting. Thanks for mentioning it.

Don
_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566



--
[hidden email]

P.S. Falls meine E-Mail kürzer ausfällt als Dir angenehm ist:
Ich probiere gerade aus kurze Antworten statt gar keine Antworten zu schreiben.
Wenn Du gerne mehr lesen möchtest, dann lass es mich bitte wissen.

P.S. In case my e-mail is shorter than you enjoy:
I am currently trying short replies instead of no replies at all.
Please let me know, if you like to read more.

Enjoy!

_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566
ds
Reply | Threaded
Open this post in threaded view
|

Re: Looking for suggestions on documenting

ds
Thanks, that does indeed help.  I also have a different solution which I will write in a separate email to the group.

On 03/29/13 11:22, Peter Falke wrote:
Hi,

I use minimagics to take dimensions off a stl when I need to. It is a free program you can get here:
http://software.materialise.com/minimagics

You can use it easily to make drawings of your stl file with dimensions and labels.

Hope it helps,

TakeItAndRun

On 29 March 2013 17:40, ds <[hidden email]> wrote:
On 03/29/13 00:00, Bryan Bishop wrote:
> On Thu, Mar 28, 2013 at 4:25 PM, ds <[hidden email]> wrote:
>> I am interested in "best practices" suggestions on documenting my
>> projects.  My use of OpenSCAD initially is designing parts that I make
> How about something like this?
>
> http://blog.reprap.org/2011/03/automatic-documentation-and-project.html
>
> - Bryan
> http://heybryan.org/
> <a moz-do-not-send="true" href="tel:1%20512%20203%200507" value="+15122030507">1 512 203 0507
That looks interesting. Thanks for mentioning it.

Don
_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566



--
[hidden email]

P.S. Falls meine E-Mail kürzer ausfällt als Dir angenehm ist:
Ich probiere gerade aus kurze Antworten statt gar keine Antworten zu schreiben.
Wenn Du gerne mehr lesen möchtest, dann lass es mich bitte wissen.

P.S. In case my e-mail is shorter than you enjoy:
I am currently trying short replies instead of no replies at all.
Please let me know, if you like to read more.

Enjoy!


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566
ds
Reply | Threaded
Open this post in threaded view
|

Re: Looking for suggestions on documenting

ds
I ended up creating some modules for dimensioning with OpenSCAD. It is a little rough, but usable.  Basically, it does things like lines with arrows, dimensions, leader lines, and title blocks.  One thing led to another and it turned into a project.

You can find it here:
http://www.cannymachines.com/entries/9/openscad_dimensioned_drawings

Hopefully, others will be able to get some use out of it.

Don

On 03/29/13 17:45, ds wrote:
Thanks, that does indeed help.  I also have a different solution which I will write in a separate email to the group.

On 03/29/13 11:22, Peter Falke wrote:
Hi,

I use minimagics to take dimensions off a stl when I need to. It is a free program you can get here:
http://software.materialise.com/minimagics

You can use it easily to make drawings of your stl file with dimensions and labels.

Hope it helps,

TakeItAndRun

On 29 March 2013 17:40, ds <[hidden email]> wrote:
On 03/29/13 00:00, Bryan Bishop wrote:
> On Thu, Mar 28, 2013 at 4:25 PM, ds <[hidden email]> wrote:
>> I am interested in "best practices" suggestions on documenting my
>> projects.  My use of OpenSCAD initially is designing parts that I make
> How about something like this?
>
> http://blog.reprap.org/2011/03/automatic-documentation-and-project.html
>
> - Bryan
> http://heybryan.org/
> <a moz-do-not-send="true" href="tel:1%20512%20203%200507" value="+15122030507">1 512 203 0507
That looks interesting. Thanks for mentioning it.

Don
_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566



--
[hidden email]

P.S. Falls meine E-Mail kürzer ausfällt als Dir angenehm ist:
Ich probiere gerade aus kurze Antworten statt gar keine Antworten zu schreiben.
Wenn Du gerne mehr lesen möchtest, dann lass es mich bitte wissen.

P.S. In case my e-mail is shorter than you enjoy:
I am currently trying short replies instead of no replies at all.
Please let me know, if you like to read more.

Enjoy!


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566



_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566


_______________________________________________
OpenSCAD mailing list
[hidden email]
http://rocklinux.net/mailman/listinfo/openscad
http://openscad.org - https://flattr.com/thing/121566