2014-07-14 7 views
7

Nei miei exploit di scripting, controllo spesso per vedere se uno script è stato scritto in precedenza prima di iniziare da zero. Spesso riesco almeno a trovare qualcosa di cui ho bisogno attraverso google o altri mezzi. Quindi adattare ciò che trovo ai miei bisogni e metterlo in produzione. Come best practice, commento il mio codice e includo le informazioni dell'autore (non sono un fan del plagio). Tuttavia, diventa la questione di come e quando è opportuno aggiungere/modificare la designazione dell'autore. Userò uno script di esempio da Ed Wilson il suo blog per riferimento:Qual è il modo corretto di condividere il credito per l'authoring e l'editing di script?

Function Get-OutlookCalendar { 
    <# 
    .Synopsis 
    This function returns appointment items from default Outlook profile 
    .Description 
    This function returns appointment items from default Outlook profile. It 
    uses the Outlook interop assembly to use the olFolderCalendar enumeration. 
    It creates a custom object consisting of Subject, Start, Duration, Location 
    for each appointment item. 
    .Example 
    Get-OutlookCalendar | 
    where-object { $_.start -gt [datetime]"5/10/2011" -AND $_.start -lt ` 
    [datetime]"5/17/2011" } | sort-object Duration 
    Displays subject, start, duration and location for all appointments that 
    occur between 5/10/11 and 5/17/11 and sorts by duration of the appointment. 
    The sort is shortest appointment on top. 
    .Notes 
    NAME: Get-OutlookCalendar 
    AUTHOR: ed wilson, msft 
    LASTEDIT: 05/10/2011 08:36:42 
    KEYWORDS: Microsoft Outlook, Office 
    HSG: HSG-05-24-2011 
    .Link 
    Http://www.ScriptingGuys.com/blog 
    #Requires -Version 2.0 
    #> 

    Add-Type -AssemblyName "Microsoft.Office.Interop.Outlook" | Out-Null 
    $olFolders = "Microsoft.Office.Interop.Outlook.OlDefaultFolders" -as [type] 
    $outlook = New-Object -ComObject Outlook.Application 
    $namespace = $outlook.GetNameSpace("MAPI") 
    $folder = $namespace.getDefaultFolder($olFolders::olFolderCalendar) 
    $folder.items | 
     Select-Object -Property Subject,Start,Duration,Location 
} 

ho visualizzare il campo autore come il punto di contatto per lo script in quanto è la persona che lo ha scritto e la comprende. C'è una regola generale su quanto viene modificato uno script prima che non abbia più senso elencare l'autore originale? O sono sempre l'autore e poi sei un editore?

Nel caso di quest'ultimo, qual è il modo appropriato per designarlo? È che si aggiunge una riga sotto Autore etichettato "Editor" e si modifica l'ultima etichetta di modifica? Qual è esattamente il modo giusto per documentare i tuoi contributi? Esiste una best practice documentata?

risposta

9

generalmente ho me stesso come l'autore e comprendono il mio (di lavoro) le informazioni di contatto, visto che i commenti sono per il consumo interno, e sarei il punto di contatto più utile per chiunque leggesse i commenti.

In genere inserisco anche un campo o una sezione "adattato da" in cui elencherò dove e da cui ho afferrato eventuali frammenti di codice. È molto meno il plagio (queste persone hanno fornito il loro codice online gratuitamente, lo si aspetta che lo persone lo copi) e molto altro ancora sulla possibilità di trovare nuovamente le risorse se necessario. Ai miei capi non interessa nemmeno un po 'di "credito" per le sceneggiature - potrei scriverlo da zero o copiare-pasta tutto il resto, finché funziona ... e sospetto che lo stesso sia vero per la maggior parte delle persone in IT .

+0

Praticamente ogni volta che prendo il codice da .net, inserisco una descrizione in alto con un collegamento all'originale insieme al nome dell'autore originale. Poi inserirò una breve descrizione di ciò che ho cambiato, se non altro per esattamente le stesse ragioni. – NotMe

3

Supponendo che si è permesso di utilizzare il codice per ciò che si intende utilizzare e rispettano tutti i/le leggi e restrizioni ....

dovrete capirlo da soli e il pubblico previsto. Se è per qualcosa che stai facendo come amministratore di sistema presso la tua azienda, a chi importa? Ti attribuisci te stesso e la fonte (s), non importa chi è l'autore e chi è l'editor.

Per qualcosa distribuito ai clienti/al mondo, probabilmente dovresti essere il contatto principale in ogni caso se qualcuno ha domande di supporto, dal momento che conta come funziona nel contesto in cui lo hai distribuito.

Per quanto riguarda author-vs-editor, questo è un modo abbastanza limitante di guardarlo. Pensa a qualcosa di simile al kernel Linux: Linux Torvalds è l'autore originale, ma c'è un sacco di persone che hanno contribuito.

(Ho votato per passare a SO, perché questo è davvero una questione di programmazione.)

+1

Non è una buona [così] domanda perché è basata sull'opinione pubblica. –

+2

Beh, non è una bella domanda di SF o – mfinni

+0

Sto girando principalmente per una buona pratica, qualcosa di documentato da qualche parte dicendo che questo è lo standard ... Ho aggiornato la mia domanda per riflettere la risposta più specifica, non basata su opinioni I sto cercando. – Colyn1337

Problemi correlati